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

Commit 9a8f222

Browse files
committed
📃 Update docs
1 parent 5f9c349 commit 9a8f222

File tree

1 file changed

+10
-8
lines changed

1 file changed

+10
-8
lines changed

{{ cookiecutter.project_name }}/README.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
[![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)
1414

1515
{{ cookiecutter.project_description }}
16+
1617
</div>
1718

1819
## Very first steps
@@ -42,8 +43,9 @@ make install
4243
```bash
4344
git add .
4445
git commit -m ":tada: Initial commit"
46+
git branch -M main
4547
git remote add origin https://github.com/{{ cookiecutter.github_name }}/{{ cookiecutter.project_name }}.git
46-
git push -u origin master
48+
git push -u origin main
4749
```
4850

4951
### Initial setting up
@@ -128,7 +130,7 @@ For creating your open source community:
128130
## Installation
129131

130132
```bash
131-
pip install {{ cookiecutter.project_name }}
133+
pip install -U {{ cookiecutter.project_name }}
132134
```
133135

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

335337
| **Label** | **Title in Releases** |
336-
|:-------------------------------------:|:----------------------:|
337-
| `enhancement`, `feature` | 🚀 Features |
338+
| :-----------------------------------: | :---------------------: |
339+
| `enhancement`, `feature` | 🚀 Features |
338340
| `bug`, `refactoring`, `bugfix`, `fix` | 🔧 Fixes & Refactoring |
339-
| `build`, `ci`, `testing` | 📦 Build System & CI/CD |
340-
| `breaking` | 💥 Breaking Changes |
341-
| `documentation` | 📝 Documentation |
342-
| `dependencies` | ⬆️ Dependencies updates |
341+
| `build`, `ci`, `testing` | 📦 Build System & CI/CD |
342+
| `breaking` | 💥 Breaking Changes |
343+
| `documentation` | 📝 Documentation |
344+
| `dependencies` | ⬆️ Dependencies updates |
343345

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

0 commit comments

Comments
 (0)