Chore: add readme + changelog

CHANGELOG.md

@@ -0,0 +1,4 @@
+## v0.1.0 (2023-11-29)
+
+- mostly working, need a bit polish
+- Published on hex.pm

README.md

@@ -1,17 +1,61 @@
 # Dryhard
 
-**TODO: Add description**
+[![CI](https://github.com/maxohq/dryhard/actions/workflows/ci.yml/badge.svg?style=flat)](https://github.com/maxohq/dryhard/actions/workflows/ci.yml)
+[![Hex.pm](https://img.shields.io/hexpm/v/dryhard.svg?style=flat)](https://hex.pm/packages/dryhard)
+[![Docs](https://img.shields.io/badge/hex-docs-lightgreen.svg?style=flat)](https://hexdocs.pm/dryhard)
+[![Total Download](https://img.shields.io/hexpm/dt/dryhard.svg?style=flat)](https://hex.pm/packages/dryhard)
+[![License](https://img.shields.io/hexpm/l/dryhard.svg?style=flat)](https://github.com/maxohq/dryhard/blob/main/LICENCE)
+
+---
+
+Quick and explicit way to get your crud actions implemented. Easy to override, not too magical.
+
+## Why use dryhard?
+...
+
+## Usage
+
+...
+
+
+## Testing
+
+...
+
+## Configuration
+
+```elixir
+## in config.exs / runtime.exs file
+...
+```
+
 
 ## Installation
 
-The package can be installed by adding `dryhard` to your list of dependencies in `mix.exs`:
+If [available in Hex](https://hex.pm/docs/publish), the package can be installed
+by adding `dryhard` to your list of dependencies in `mix.exs`:
 
 ```elixir
 def deps do
   [
-    {:dryhard, "~> 0.1.0"}
+    {:dryhard, "~> 0.1"}
   ]
 end
 ```
 
-The docs can be found at <https://hexdocs.pm/dryhard>.
+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/dryhard>.
+
+## Support
+
+<p>
+  <a href="https://quantor.consulting/?utm_source=github&utm_campaign=dryhard">
+    <img src="https://raw.githubusercontent.com/maxohq/sponsors/main/assets/quantor_consulting_logo.svg"
+      alt="Sponsored by Quantor Consulting" width="210">
+  </a>
+</p>
+
+## License
+
+The lib is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).