diff --git a/README.md b/README.md index b1e70c1..0c29ddd 100644 --- a/README.md +++ b/README.md @@ -1 +1,22 @@ # Databases should be _Effortless_. + +[![Publish Package](https://github.com/bboonstra/Effortless/actions/workflows/publish.yml/badge.svg?branch=main)](https://github.com/bboonstra/Effortless/actions/workflows/publish.yml) +[![Run Tests](https://github.com/bboonstra/Effortless/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/bboonstra/Effortless/actions/workflows/test.yml) + +Effortless has one objective: be the easiest database. +It's perfect for beginners, but effortless for anyone. + +## Quickstart + +```bash +pip install effortless +``` + +## Usage + +```python3 +import effortless as db +db.set("test") +print(db.get()) +test +```