summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorYuval Adam <_@yuv.al>2024-05-07 21:31:06 +0200
committerYuval Adam <_@yuv.al>2024-05-07 21:31:06 +0200
commit91beb2cf2a5578dd2b29fb2c488cb5d2a156db2f (patch)
tree6e3e015339ac43f8eb8c5a2300bdcf1d1859018d
parent48f499507187e76f02acb563b46e6b32328b0777 (diff)
Publish and add installation notesv1.0.0
-rw-r--r--.gitignore1
-rw-r--r--README.md10
2 files changed, 11 insertions, 0 deletions
diff --git a/.gitignore b/.gitignore
index 323ded3..97a9282 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,4 +1,5 @@
__pycache__/
.pytest_cache/
+dist/
poetry.lock
diff --git a/README.md b/README.md
index 651832c..fff5978 100644
--- a/README.md
+++ b/README.md
@@ -2,6 +2,16 @@
A simple ORM-like utility for operating on local YAML files via Python dataclasses.
+## Install
+
+Package is published on PyPI - https://pypi.org/project/ymlstash/
+
+Install from pip or your favorite package manager:
+
+```bash
+$ pip install ymlstash
+```
+
## Usage
Define a dataclass: