Skip to content

Commit 467ca1a

Browse files
committed
doc: updated readme
1 parent 2a78081 commit 467ca1a

1 file changed

Lines changed: 33 additions & 1 deletion

File tree

README.md

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,35 @@
1-
# kingdom_core
1+
# 🏰 Kingdom Core
22

33
Library containing the core modules for the kingdom-python-server.
4+
5+
## Installation
6+
7+
Use the package manager [pip](https://pip.pypa.io/en/stable/) to install `kingdom-core`.
8+
9+
```bash
10+
pip install kingdom-core
11+
```
12+
13+
You can use [poetry]() as well.
14+
15+
```bash
16+
poetry add kingdom-core
17+
```
18+
19+
## Usage
20+
21+
```python
22+
from kingdom_core.utils import files
23+
24+
orm_files = files.find("orm.py", "/")
25+
```
26+
27+
## Contributing
28+
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
29+
30+
Please make sure to update tests as appropriate.
31+
32+
## License
33+
[MIT](https://choosealicense.com/licenses/mit/)
34+
35+
> This file is based on [Make a README](https://www.makeareadme.com/).

0 commit comments

Comments
 (0)