Skip to content

Commit

Permalink
will the badge work
Browse files Browse the repository at this point in the history
  • Loading branch information
stringertheory committed Jun 5, 2023
1 parent 1241c87 commit 54fce1e
Show file tree
Hide file tree
Showing 2 changed files with 1,054 additions and 43 deletions.
44 changes: 1 addition & 43 deletions README.md
@@ -1,54 +1,12 @@
# json-explorer

[![Release](https://img.shields.io/github/v/release/stringertheory/json-explorer)](https://img.shields.io/github/v/release/stringertheory/json-explorer)
![Release](https://img.shields.io/github/v/release/stringertheory/json-explorer?include_prereleases)
[![Build status](https://img.shields.io/github/actions/workflow/status/stringertheory/json-explorer/main.yml?branch=main)](https://github.com/stringertheory/json-explorer/actions/workflows/main.yml?query=branch%3Amain)
[![codecov](https://codecov.io/gh/stringertheory/json-explorer/branch/main/graph/badge.svg)](https://codecov.io/gh/stringertheory/json-explorer)
[![Commit activity](https://img.shields.io/github/commit-activity/m/stringertheory/json-explorer)](https://img.shields.io/github/commit-activity/m/stringertheory/json-explorer)
[![License](https://img.shields.io/github/license/stringertheory/json-explorer)](https://img.shields.io/github/license/stringertheory/json-explorer)

Explore the structure of a bunch of jsons

- **Github repository**: <https://github.com/stringertheory/json-explorer/>
- **Documentation** <https://stringertheory.github.io/json-explorer/>

## Getting started with your project

First, create a repository on GitHub with the same name as this project, and then run the following commands:

``` bash
git init -b main
git add .
git commit -m "init commit"
git remote add origin git@github.com:stringertheory/json-explorer.git
git push -u origin main
```

Finally, install the environment and the pre-commit hooks with

```bash
make install
```

You are now ready to start development on your project! The CI/CD
pipeline will be triggered when you open a pull request, merge to main,
or when you create a new release.

To finalize the set-up for publishing to PyPi or Artifactory, see
[here](https://fpgmaas.github.io/cookiecutter-poetry/features/publishing/#set-up-for-pypi).
For activating the automatic documentation with MkDocs, see
[here](https://fpgmaas.github.io/cookiecutter-poetry/features/mkdocs/#enabling-the-documentation-on-github).
To enable the code coverage reports, see [here](https://fpgmaas.github.io/cookiecutter-poetry/features/codecov/).

## Releasing a new version

- Create an API Token on [Pypi](https://pypi.org/).
- Add the API Token to your projects secrets with the name `PYPI_TOKEN` by visiting
[this page](https://github.com/stringertheory/json-explorer/settings/secrets/actions/new).
- Create a [new release](https://github.com/stringertheory/json-explorer/releases/new) on Github.
Create a new tag in the form ``*.*.*``.

For more details, see [here](https://fpgmaas.github.io/cookiecutter-poetry/features/cicd/#how-to-trigger-a-release).

---

Repository initiated with [fpgmaas/cookiecutter-poetry](https://github.com/fpgmaas/cookiecutter-poetry).

0 comments on commit 54fce1e

Please sign in to comment.