dwyl / alog

🌲 alog (Append-only Log) is an easy way to start using the Lambda/Kappa architecture in your Elixir/Phoenix Apps while still using PostgreSQL (with Ecto).
GNU General Public License v2.0
15 stars 2 forks source link

Update documentation/README #18

Open SimonLab opened 5 years ago

SimonLab commented 5 years ago

"Our first/next step is to make the docs for https://github.com/dwyl/alog super beginner friendly." :+1: ref: https://github.com/dwyl/technology-stack/issues/67#issuecomment-437145610

see also https://github.com/dwyl/phoenix-ecto-append-only-log-example for an example on how to implement an append only logic with Phoenix.

Elixir v1.7 provide some new features for writing documentation: from https://elixir-lang.org/blog/2018/07/25/elixir-v1-7-0-released/ image

Creating documentation with Hexdoc: from https://hexdocs.pm/ image