docs: update readme

vaetas · Nov 15, 2020 · 0c072e8 · 0c072e8
1 parent 29deba1
commit 0c072e8
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 8 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,3 @@
+## [0.1.0] - 2020-11-15
+
+* Initial release.
diff --git a/README.md b/README.md
@@ -5,21 +5,31 @@
 
 Blake is an experimental static site generator in Dart language.
 
+Features as of now:
+
+* Markdown support.
+* YAML configuration and front-matter.
+* Mustache templates.
+* Live-reload.
+* Single native binary.
+
+Remember that this project is WIP. Everything can change at any time.
+
 ## Usage
 
-Use `blake init` to setup a new project in current directory. `blake init name` will setup the project
-inside `name` directory.
+Use `blake init` to setup a new project in the current directory. `blake init <name>` will setup the project inside the `<name>` directory.
+
+Use `blake build` to generate the site from your files. By default, generated files will be outputted into the `public` folder.
 
-Use `blake build` to generate the site from your files.
+Use `blake serve` to start a webserver to see your site instantly. The site will be rebuilt every time you change files in your project and the browser tab will be reloaded automatically.
 
-Use `blake serve` to start a webserver to see your site instantly. Site will be rebuilt every time
-you change files in your project and the browser tab will be reloaded automatically.
+And as usual, `blake` or `blake help` will show usage help.
 
 ## Structure
 
 `content` directory contains all Markdown files which will be transformed into HTML files.
 
-`static` directory files will be copied into generated site without change.
+`static` directory files will be copied into `public` folder without change.
 
 `public` contains generated files.
 
@@ -29,8 +39,7 @@ you change files in your project and the browser tab will be reloaded automatica
 
 ## Build
 
-To create native binary use following command. You need to have installed full Dart SDK at your computer
-(Dart packaged with Flutter is not enough).
+To create native binary use the following command. You need to have installed full Dart SDK at your computer (Dart packaged with Flutter is not enough).
 
 ```
 # Windows