Add Readme

README.md

@@ -1,6 +1,6 @@
 # Ancestry
 
-**TODO: Add description**
+_WIP_
 
 ## Installation
 
@@ -13,7 +13,64 @@ def deps do
 end
 ```
 
-Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)
-and published on [HexDocs](https://hexdocs.pm). Once published, the docs can
-be found at [https://hexdocs.pm/ancestry](https://hexdocs.pm/ancestry).
+### Usage
+Add an `ancestry` string field in your model
 
+```bash
+mix ecto.gen.migration add_ancestry_to_<model>
+```
+
+Add index to migration
+
+```elixir
+defmodule Migration do
+  use Ecto.Migration
+
+  def change do
+    create table(:<model>) do
+      add :ancestry, :string
+
+      timestamps()
+    end
+    create index(:<model>, [:ancestry])
+  end
+end
+```
+
+```bash
+mix ecto.migrate
+```
+
+Add `use Ancestry` to your model ex:
+
+```elixir
+defmodule Page do
+  use Ecto.Schema
+  use Ancestry
+
+  import Ecto.Changeset
+
+  schema "pages" do
+    field :ancestry, :string
+  end
+
+  def changeset(struct, params) do
+    struct
+    |> cast(params, [:ancestry])
+  end
+end
+
+```
+
+### TODO
+
+- [ ] roots
+- [ ] ancestors
+- [ ] children
+- [ ] descendants
+- [ ] siblings
+- [ ] tests
+
+## License
+
+This package is available as open source under the terms of the [MIT License](LICENSE.md).

lib/ancestry.ex

@@ -14,6 +14,7 @@ defmodule Ancestry do
       @orphan_stategy options[:orphan_strategy] || :destroy
 
 
+      # ---- Delete a model and apply_orphan_strategy
       def delete(model) do
         multi =
           Multi.new