Skip to content

Commit

Permalink
Add content to README
Browse files Browse the repository at this point in the history
  • Loading branch information
bboonstra committed Oct 19, 2024
1 parent a933c4f commit 857a406
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
```

0 comments on commit 857a406

Please sign in to comment.