Skip to content

Commit af4f248

Browse files
committed
Updated README.md 📝
1 parent a7237ab commit af4f248

File tree

1 file changed

+39
-2
lines changed

1 file changed

+39
-2
lines changed

README.md

Lines changed: 39 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,39 @@
1-
# Yaml-Python
2-
Allows me to add annotation to get value
1+
# Yaml8
2+
3+
## Project Description
4+
5+
Python package to make getting yaml easier and cleaner
6+
7+
## Installation
8+
9+
To install with pip <br>
10+
11+
```
12+
$ pip install Yaml8
13+
```
14+
15+
## Usage
16+
17+
```python
18+
y = Yaml(f"{os.path.dirname(os.path.realpath(__file__))}/app.yaml")
19+
20+
env = os.getenv('env')
21+
22+
@y.value(f"instagram-{env}.profile")
23+
def profiles(): pass
24+
@y.value(f"instagram-{env}.session-id")
25+
def sessionId(): pass
26+
```
27+
28+
## Credits
29+
30+
<table>
31+
<tr>
32+
<td align="center"><a href="https://github.com/appdevin"><img src="https://avatars1.githubusercontent.com/u/34540492?s=460&u=6b2d7e8346afc28bfd8e591d93fd548895c720af&v=4" width="100px;" alt=""/><br /><sub><b>Jeyavishnu</b></sub></a><br />
33+
</td>
34+
</tr>
35+
</table>
36+
37+
## License
38+
39+
Distributed under the MIT License. See `LICENSE` for more information.

0 commit comments

Comments
 (0)