Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Update README #25

Merged
merged 1 commit into from
Apr 23, 2024
Merged

docs: Update README #25

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 16 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,18 @@
## ✨ Features

- Focus on simplicity
- Focus on using Derive Macros
- Rely on Derive Macros to generate code for your structs
- Using `GeekTable`
- Dynamically build queries
- `Select`, `Create`, `Update`, and `Insert` queries
- Generate helper functions
- Select `select_by_primary_key()` & `select_by_{field}()`
- New instance `new`
- Support for Backends
- [`libsql`][lib-libsql] ([Turso][web-turso])
- [Documentation][docs]

## Usage
## 📦 Usage

You can install the library from [crates.io][crates]:

Expand All @@ -38,7 +46,7 @@ cargo add geekorm
cargo install --git https://github.com/42ByteLabs/geekorm
```

## Maintainers / Contributors
## 🧑‍🤝‍🧑 Maintainers / Contributors

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
Expand All @@ -57,13 +65,13 @@ cargo install --git https://github.com/42ByteLabs/geekorm

<!-- ALL-CONTRIBUTORS-LIST:END -->

## Support
## 🦸 Support

Please create [GitHub Issues][github-issues] if there are bugs or feature requests.

This project uses [Semantic Versioning (v2)][semver] and with major releases, breaking changes will occur.

## License
## 📓 License

This project is licensed under the terms of the MIT open source license.
Please refer to [MIT][license] for the full terms.
Expand All @@ -79,3 +87,6 @@ Please refer to [MIT][license] for the full terms.
[github-issues]: https://github.com/42ByteLabs/geekorm/issues
[crates]: https://crates.io
[docs-orm]: https://en.wikipedia.org/wiki/Object%E2%80%93relational_mapping

[lib-libsql]: https://github.com/tursodatabase/libsql
[web-turso]: https://turso.tech/