Skip to content

Commit

Permalink
Update docs #9
Browse files Browse the repository at this point in the history
Update docs
  • Loading branch information
ycd authored Aug 9, 2020
2 parents e497ac9 + db5924c commit 4695df5
Show file tree
Hide file tree
Showing 3 changed files with 34 additions and 18 deletions.
22 changes: 4 additions & 18 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@


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



## Features :rocket:
## Features 🚀

* #### Creates customizable **project boilerplate.**
* #### Creates customizable **app boilerplate.**
* #### More will come soon.


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

## Installation :pushpin:
## Installation 📌

`pip install manage-fastapi`


## Release Notes :mega:

### Latest Changes

### 0.1.1

* Added documentation
* Fixed typos
* Additional response for successfuly creation.

### 0.1.0

* Prototype of project with two functionalities.

## License

This project is licensed under the terms of the MIT license.
19 changes: 19 additions & 0 deletions docs/release-notes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
## Release Notes 📣

### Latest Changes

### 0.1.2

* Add tests
* Fix and relocate success message
* Add travis

### 0.1.1

* Added documentation
* Fixed typos
* Additional response for successfuly creation.

### 0.1.0

* Prototype of project with two functionalities.
11 changes: 11 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,17 @@ nav:
- Start new project: managing_projects/startproject.md
- Manage Apps:
- Start new app: managing_apps/startapp.md
- Release Notes: 'release-notes.md'


markdown_extensions:
- toc:
permalink: true
- markdown.extensions.codehilite:
guess_lang: false
- admonition
- codehilite
- extra
- tables
- smarty
- pymdownx.tabbed

0 comments on commit 4695df5

Please sign in to comment.