diff --git a/README.md b/README.md index 75445ef..a4e8420 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,10 @@ Mebe -- _the Minimalistic Elixir Blog Engine_ -- is a simple blog engine written in [Elixir](https://elixir-lang.org), using the [Phoenix Framework](http://www.phoenixframework.org/). +**NOTE:** Mebe is tailored for my own use at [my blog](https://blog.nytsoi.net/). Some +things are made configurable, but some are not and usage instructions are currently very +scarce. So proceed with caution. + The engine consists of two parts: 1. MebeEngine, which handles parsing the data files into an ETS (_Erlang Term Storage_) in-memory database, and @@ -13,7 +17,8 @@ The engine consists of two parts: * `git clone` * Copy `config/*.exs.dist`, removing the `.dist` ending and go through the configs. -* `npm install && mix frontend.build` to build the frontend. +* `npm install && mix frontend.build` to build the frontend. Use `MIX_ENV=prod` to build + minified files. * Put some content into the data path you specified, at least a `menu` file. * `mix phoenix.server` to run the development server.