Update README.md

Author: Fanmade

README.md

@@ -1,2 +1,100 @@
-# laravel-bitwise-trait
+# Laravel Bitwise Trait
 Simple trait to use bitwise operators on any class
+Inspired by http://php.net/manual/de/language.operators.bitwise.php#108679
+
+I just used it in Laravel so far, but you should be able to use it anyhwere else with minor modifications.
+
+## Installation
+Just put the file in app/Traits (create the folder if it doesn't exist yet) and you're good to go. 
+You are free to place it anywhere else, just change the namespace accordingly.
+
+## Usage
+
+*This example is for a default Laravel (5.4) Model within the "App" namespace.*
+You need an (ideally unsigned) integer field in your database which will store the properties.
+The length does depend on the number of values you would like to store. You only need one bit per value, so it's 8 values for each byte, if the column is unsigned.
+Examples (based on laravel migrations):
+```php
+$table->tinyInteger('status'); // 1 byte -> maximum of 7 different values
+$table->unsignedTinyInteger('status'); // maximum of 8 different values
+$table->smallInteger('status'); // 2 byte -> maximum of 16 different values
+$table->unsignedSmallInteger('status'); // maximum of 17 different values
+$table->mediumInteger('status'); // 3 byte -> maximum of 24 different values
+```
+You get the idea. Most times, you probably only need an unsigned tinyInteger :)
+There are only a few use-cases, but you can add as many fields as you like.
+
+Include the Trait in your model like this:
+```php
+<?php namespace App;
+use App\Traits\BitwiseFlagTrait;
+
+class Message extends Model
+{
+
+  use BitwiseFlagTrait;
+```
+
+The best way to define your properties is via constants.
+```php
+const MESSAGE_SENT = 1; // BIT #1 of has the value 1
+const MESSAGE_RECEIVED = 2; // BIT #2 of has the value 2
+const MESSAGE_SEEN = 4; // BIT #3 of has the value 4
+const MESSAGE_READ = 8; // BIT #4 of has the value 8
+```
+
+To set a property, just call the function like this:
+```php
+$this->setFlag('status', MESSAGE_SENT, true);
+```
+
+To get a property, just call the function like this:
+```php
+$sent = $this->getFlag('status', MESSAGE_SENT);
+```
+The first parameter is always the field you set in the database.
+
+To make your life easier, I recommend to use custom getters and setters.
+```php
+
+    /**
+     * @param bool $sent
+     * @return bool
+     */
+    public function setSentAttribute($sent = true)
+    {
+        return $this->setFlag('status',MESSAGE_SENT, $sent);
+    }
+
+    /**
+     * @return bool
+     */
+    public function getSentAttribute()
+    {
+        return $this->getFlag('status', MESSAGE_SENT);
+    }
+
+```
+
+## Scopes
+If you want to use the new field in scopes, you can do that like this:
+```php
+    /**
+     * @param Builder $query
+     * @return Builder
+     */
+    public function scopeUnread($query)
+    {
+        return $query->whereRAW('NOT status & ' . MESSAGE_READ);
+    }
+
+    /**
+     * @param Builder $query
+     * @return Builder
+     */
+    public function scopeRead($query)
+    {
+        return $query->where('status', '&', MESSAGE_READ);
+    }
+
+```