Skip to content

Commit

Permalink
docs: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
thetutlage committed Sep 19, 2023
1 parent e50c45d commit 98d74e9
Showing 1 changed file with 24 additions and 36 deletions.
60 changes: 24 additions & 36 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,53 +1,41 @@
<div align="center">
<img src="https://res.cloudinary.com/adonisjs/image/upload/q_100/v1558612869/adonis-readme_zscycu.jpg" width="600px">
</div>
# @adonisjs/lucid

<br />

<div align="center">
<h3>SQL ORM</h3>
<p>Lucid is the official SQL ORM for AdonisJS. It comes with an Active Record ORM, Query Builder, Migrations, Seeds and Factories</p>
</div>
[![gh-workflow-image]][gh-workflow-url] [![npm-image]][npm-url] ![][typescript-image] [![license-image]][license-url]

<br />
## Introduction
SQL ORM for AdonisJS built on top of Knex. Comes with a db query builder, Active record ORM, migrations, seeders and model factories.

## Official Documentation
The documentation is available on the [AdonisJS website](https://docs.adonisjs.com/guides/database/introduction)

## Contributing
One of the primary goals of AdonisJS is to have a vibrant community of users and contributors who believes in the principles of the framework.

<div align="center">
We encourage you to read the [contribution guide](https://github.com/adonisjs/.github/blob/main/docs/CONTRIBUTING.md) before contributing to the framework.

[![gh-workflow-image]][gh-workflow-url] [![typescript-image]][typescript-url] [![npm-image]][npm-url] [![license-image]][license-url] [![synk-image]][synk-url]
### Run tests locally
Easiest way to run tests is to launch the redis cluster using docker-compose and `docker-compose.yml` file.

</div>
```sh
docker-compose up
npm run test
```

<div align="center">
<h3>
<a href="https://adonisjs.com">
Website
</a>
<span> | </span>
<a href="https://docs.adonisjs.com/guides/database/introduction">
Guides
</a>
<span> | </span>
<a href=".github/CONTRIBUTING.md">
Contributing
</a>
</h3>
</div>
## Code of Conduct
In order to ensure that the AdonisJS community is welcoming to all, please review and abide by the [Code of Conduct](https://github.com/adonisjs/.github/blob/main/docs/CODE_OF_CONDUCT.md).

<div align="center">
<sub>Built with ❤︎ by <a href="https://twitter.com/AmanVirk1">Harminder Virk</a>
</div>
## License
AdonisJS Redis is open-sourced software licensed under the [MIT license](LICENSE.md).

[gh-workflow-image]: https://img.shields.io/github/actions/workflow/status/adonisjs/lucid/test.yml?style=for-the-badge
[gh-workflow-url]: https://github.com/adonisjs/lucid/actions/workflows/test.yml "Github action"

[typescript-image]: https://img.shields.io/badge/Typescript-294E80.svg?style=for-the-badge&logo=typescript
[typescript-url]: "typescript"

[npm-image]: https://img.shields.io/npm/v/@adonisjs/lucid/latest.svg?style=for-the-badge&logo=npm
[npm-url]: https://www.npmjs.com/package/@adonisjs/lucid/v/latest "npm"

[license-image]: https://img.shields.io/npm/l/@adonisjs/lucid?color=blueviolet&style=for-the-badge
[license-url]: LICENSE.md "license"
[typescript-image]: https://img.shields.io/badge/Typescript-294E80.svg?style=for-the-badge&logo=typescript

[synk-image]: https://img.shields.io/snyk/vulnerabilities/github/adonisjs/lucid?label=Synk%20Vulnerabilities&style=for-the-badge
[synk-url]: https://snyk.io/test/github/adonisjs/lucid?targetFile=package.json "synk"
[license-url]: LICENSE.md
[license-image]: https://img.shields.io/github/license/adonisjs/lucid?style=for-the-badge

0 comments on commit 98d74e9

Please sign in to comment.