Skip to content
This repository has been archived by the owner on Feb 7, 2024. It is now read-only.

Commit

Permalink
📃 Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
TezRomacH committed Jan 20, 2021
1 parent 5f9c349 commit 9a8f222
Showing 1 changed file with 10 additions and 8 deletions.
18 changes: 10 additions & 8 deletions {{ cookiecutter.project_name }}/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
[![License](https://img.shields.io/github/license/{{ cookiecutter.github_name }}/{{ cookiecutter.project_name }})](https://github.com/{{ cookiecutter.github_name }}/{{ cookiecutter.project_name }}/blob/master/LICENSE)

{{ cookiecutter.project_description }}

</div>

## Very first steps
Expand Down Expand Up @@ -42,8 +43,9 @@ make install
```bash
git add .
git commit -m ":tada: Initial commit"
git branch -M main
git remote add origin https://github.com/{{ cookiecutter.github_name }}/{{ cookiecutter.project_name }}.git
git push -u origin master
git push -u origin main
```

### Initial setting up
Expand Down Expand Up @@ -128,7 +130,7 @@ For creating your open source community:
## Installation

```bash
pip install {{ cookiecutter.project_name }}
pip install -U {{ cookiecutter.project_name }}
```

or install with `Poetry`
Expand Down Expand Up @@ -333,13 +335,13 @@ We use [`Release Drafter`](https://github.com/marketplace/actions/release-drafte
For Pull Request this labels are configured, by default:

| **Label** | **Title in Releases** |
|:-------------------------------------:|:----------------------:|
| `enhancement`, `feature` | 🚀 Features |
| :-----------------------------------: | :---------------------: |
| `enhancement`, `feature` | 🚀 Features |
| `bug`, `refactoring`, `bugfix`, `fix` | 🔧 Fixes & Refactoring |
| `build`, `ci`, `testing` | 📦 Build System & CI/CD |
| `breaking` | 💥 Breaking Changes |
| `documentation` | 📝 Documentation |
| `dependencies` | ⬆️ Dependencies updates |
| `build`, `ci`, `testing` | 📦 Build System & CI/CD |
| `breaking` | 💥 Breaking Changes |
| `documentation` | 📝 Documentation |
| `dependencies` | ⬆️ Dependencies updates |

You can update it in [`release-drafter.yml`](https://github.com/{{ cookiecutter.github_name }}/{{ cookiecutter.project_name }}/blob/master/.github/release-drafter.yml).

Expand Down

0 comments on commit 9a8f222

Please sign in to comment.