From 8659fe2a12bf3fecfaef2112fabc871356f445a9 Mon Sep 17 00:00:00 2001 From: Yacine Petitprez Date: Thu, 9 Aug 2018 17:00:24 +0800 Subject: [PATCH] Reorganize slightly the README --- README.md | 47 +++++++++++++++++++++++++---------------------- 1 file changed, 25 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index b362fe434..4ec109d36 100644 --- a/README.md +++ b/README.md @@ -7,25 +7,43 @@ Clear is an ORM built specifically for PostgreSQL in Crystal. -It follows Active Record design pattern, with emphasis on readability and a -native coverage of Postgres advanced features like jsonb, hstore, ts-vector.... +It's probably the most advanced ORM in term of features offered. It features +Active Record pattern models, and low-level SQL builder. + +You can deal out of the box with jsonb, tsvectors, cursors, CTE, bcrypt password, +array, uuid primary key, foreign constraints... and other things ! +It also has a powerful DSL to construct `where` and `having` clauses. + +The philosophy beneath is to please me (and you !) with emphasis made on business +code readability and minimal setup. It is in active development and actively maintained ! ## Why to use Clear ? -You want to use Clear if: +In few seconds, you want to use Clear if: - [X] You want an expressive ORM. Put straight your thought to your code ! - [X] You'd like to use advanced Postgres features without hassle -- [X] You'd like to have your issue fixed in a day or two (we are active !) +- [X] You are at aware of the pro and cons of Active Records pattern You don't want to use Clear if: -- [ ] You need pure performance. Or you can use just the SQL builder API. +- [ ] You need pure performance +- [ ] You look for a minimalist ORM / Data Mapper - [ ] You're obviously not on PostgreSQL -- [ ] You need something which doesn't evolve (e.g. production ready). - Clear is still in alpha (but starting to mature !). +- [ ] You need something which doesn't evolve, with breaking changes. + Clear is still in alpha but starting to mature ! + +## Getting started + +- [Please check the manual which cover most of the library here](https://github.com/anykeyh/clear/tree/master/manual) + - The manual is available offline in the `manual` directory +- [API Documentations (Autogenerated)](https://anykeyh.github.io/clear/) +- [Source Code](https://github.com/anykeyh/clear) +- [A simple example is available here](https://github.com/anykeyh/clear/blob/master/sample/wiki/getting_started.cr) +- [Changelog](https://github.com/anykeyh/clear/blob/master/CHANGELOG.md) +- [Credits](https://github.com/anykeyh/clear/tree/master/CONTRIBUTORS.md) ## Features @@ -55,21 +73,6 @@ You don't want to use Clear if: - Transaction, rollback, savepoint - Access to CTE, locks, cursors, scope, pagination, join, window, multi-connection and many others features - Model lifecycle/hooks - -## Getting started - -- [Please check the manual which cover most of the library here](https://github.com/anykeyh/clear/tree/master/manual) - - The manual is available offline in the `manual` directory -- [API Documentations (Autogenerated)](https://anykeyh.github.io/clear/) -- [Source Code](https://github.com/anykeyh/clear) -- [A simple example is available here](https://github.com/anykeyh/clear/blob/master/sample/wiki/getting_started.cr) -- [Changelog](https://github.com/anykeyh/clear/blob/master/CHANGELOG.md) -- [Credits](https://github.com/anykeyh/clear/tree/master/CONTRIBUTORS.md) - -## Getting started - -A full sample is available on the [wiki](https://github.com/anykeyh/clear/wiki/getting_started) - ### Installation In `shards.yml`