Skip to content

Commit 64306cd

Browse files
committed
πŸ“ Add initial version of README.md, CONTRIBUTING.md, release-notes.md, SECURITY.md
1 parent b68d0db commit 64306cd

File tree

4 files changed

+58
-1
lines changed

4 files changed

+58
-1
lines changed

β€ŽCONTRIBUTING.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Contributing

β€ŽREADME.md

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,25 @@
1-
# fastapi-cli
1+
# FastAPI CLI
2+
3+
<a href="https://github.com/tiangolo/fastapi-cli/actions?query=workflow%3ATest" target="_blank">
4+
<img src="https://github.com/tiangolo/fastapi-cli/workflows/Test/badge.svg" alt="Test">
5+
</a>
6+
<a href="https://github.com/tiangolo/fastapi-cli/actions?query=workflow%3APublish" target="_blank">
7+
<img src="https://github.com/tiangolo/fastapi-cli/workflows/Publish/badge.svg" alt="Publish">
8+
</a>
9+
<a href="https://coverage-badge.samuelcolvin.workers.dev/redirect/tiangolo/fastapi-cli" target="_blank">
10+
<img src="https://coverage-badge.samuelcolvin.workers.dev/tiangolo/fastapi-cli.svg" alt="Coverage">
11+
<a href="https://pypi.org/project/fastapi-cli" target="_blank">
12+
<img src="https://img.shields.io/pypi/v/fastapi-cli?color=%2334D058&label=pypi%20package" alt="Package version">
13+
</a>
14+
15+
---
16+
17+
**Source Code**: <a href="https://github.com/tiangolo/fastapi-cli" target="_blank">https://github.com/tiangolo/fastapi-cli</a>
18+
19+
---
20+
21+
Run FastAPI applications from the command line with FastAPI CLI. πŸš€
22+
23+
## License
24+
25+
This project is licensed under the terms of the MIT license.

β€ŽSECURITY.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Security Policy
2+
3+
Security is very important for FastAPI and its community. πŸ”’
4+
5+
Learn more about it below. πŸ‘‡
6+
7+
## Versions
8+
9+
The latest versions of FastAPI and FastAPI CLI are supported.
10+
11+
You are encouraged to write tests for your application and update your FastAPI and FastAPI CLI version frequently after ensuring that your tests are passing. This way you will benefit from the latest features, bug fixes, and **security fixes**.
12+
13+
## Reporting a Vulnerability
14+
15+
If you think you found a vulnerability, and even if you are not sure about it, please report it right away by sending an email to: [email protected]. Please try to be as explicit as possible, describing all the steps and example code to reproduce the security issue.
16+
17+
I (the author, [@tiangolo](https://twitter.com/tiangolo)) will review it thoroughly and get back to you.
18+
19+
## Public Discussions
20+
21+
Please restrain from publicly discussing a potential security vulnerability. πŸ™Š
22+
23+
It's better to discuss privately and try to find a solution first, to limit the potential impact as much as possible.
24+
25+
---
26+
27+
Thanks for your help!
28+
29+
The FastAPI community and I thank you for that. πŸ™‡

β€Žrelease-notes.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Release Notes
2+
3+
## Latest Changes

0 commit comments

Comments
Β (0)