Skip to content

Commit 4695df5

Browse files
authored
Update docs #9
Update docs
2 parents e497ac9 + db5924c commit 4695df5

File tree

3 files changed

+34
-18
lines changed

3 files changed

+34
-18
lines changed

Diff for: docs/index.md

+4-18
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22

33
<h3 align="center">
4-
<strong>Managing FastAPI projects made easy</strong>
4+
<strong>Managing FastAPI projects made easy.</strong>
55
</h3>
66
<p align="center">
77
<img src="https://img.shields.io/github/issues/ycd/manage-fastapi?style=for-the-badge">
@@ -31,14 +31,14 @@
3131

3232

3333

34-
## Features :rocket:
34+
## Features 🚀
3535

3636
* #### Creates customizable **project boilerplate.**
3737
* #### Creates customizable **app boilerplate.**
3838
* #### More will come soon.
3939

4040

41-
## Example folder structure for more check [documentation](https://ycd.github.io/manage-fastapi/)
41+
## Example folder structure 📦
4242
```
4343
newproject/
4444
├── __init__.py
@@ -64,25 +64,11 @@ newproject/
6464
└── __init__.py
6565
```
6666

67-
## Installation :pushpin:
67+
## Installation 📌
6868

6969
`pip install manage-fastapi`
7070

7171

72-
## Release Notes :mega:
73-
74-
### Latest Changes
75-
76-
### 0.1.1
77-
78-
* Added documentation
79-
* Fixed typos
80-
* Additional response for successfuly creation.
81-
82-
### 0.1.0
83-
84-
* Prototype of project with two functionalities.
85-
8672
## License
8773

8874
This project is licensed under the terms of the MIT license.

Diff for: docs/release-notes.md

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
## Release Notes 📣
2+
3+
### Latest Changes
4+
5+
### 0.1.2
6+
7+
* Add tests
8+
* Fix and relocate success message
9+
* Add travis
10+
11+
### 0.1.1
12+
13+
* Added documentation
14+
* Fixed typos
15+
* Additional response for successfuly creation.
16+
17+
### 0.1.0
18+
19+
* Prototype of project with two functionalities.

Diff for: mkdocs.yml

+11
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,17 @@ nav:
1515
- Start new project: managing_projects/startproject.md
1616
- Manage Apps:
1717
- Start new app: managing_apps/startapp.md
18+
- Release Notes: 'release-notes.md'
19+
1820

1921
markdown_extensions:
22+
- toc:
23+
permalink: true
24+
- markdown.extensions.codehilite:
25+
guess_lang: false
26+
- admonition
2027
- codehilite
28+
- extra
29+
- tables
30+
- smarty
31+
- pymdownx.tabbed

0 commit comments

Comments
 (0)