docs: update README.md and CHANGELOG.md for first release

spaceonfire · May 27, 2020 · 07fd79e · 07fd79e
1 parent 8b0123e
commit 07fd79e
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 16 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -21,3 +21,7 @@ Updates should follow the [Keep a CHANGELOG](http://keepachangelog.com/) princip
 ### Security
 - Nothing
 -->
+
+## [1.0.0] - 2020-05-27
+### Added
+- First stable release
diff --git a/README.md b/README.md
@@ -6,20 +6,6 @@
 
 Criteria help you to declare rules to filter datasets
 
-## Structure
-
-If any of the following are applicable to your project, then the directory structure should follow industry best practices by being named the following.
-
-```
-bin/
-build/
-docs/
-config/
-src/
-tests/
-vendor/
-```
-
 ## Install
 
 Via Composer
@@ -31,8 +17,12 @@ $ composer require spaceonfire/criteria
 ## Usage
 
 ```php
-$skeleton = new spaceonfire\Criteria\Criteria();
-echo $skeleton->echoPhrase('Hello, League!');
+use spaceonfire\Criteria\Criteria;
+$criteria = new Criteria();
+$criteria->where(Criteria::expr()->property('name', Criteria::expr()->equals('Ben')))
+    ->orderBy(['lastName' => SORT_ASC])
+    ->offset(50)
+    ->limit(25);
 ```
 
 ## Change log