Add changelog and publish v0.1 🎉

BafS · Sep 2, 2018 · 13d2efb · 13d2efb
1 parent bb52164
commit 13d2efb
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 3 deletions.
diff --git a/Changelog.md b/Changelog.md
@@ -0,0 +1,17 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+## [0.1.0] - 2018-09-02
+### Added
+- Table style
+
+### Fixed
+- Parsing was breaking with multiple delimiters
+
+### Changed
+- Create a parsers folder and refactored the parsing
+- Reads the version from package.json
+- Upgrade packages
diff --git a/Readme.md b/Readme.md
@@ -1,4 +1,4 @@
-<a href="https://bafs.github.io/Documentor" target="_blank"><img width="600" src="https://i.imgur.com/6Gjb6Gz.png" /></a>
+<a href="https://bafs.github.io/Documentor" target="_blank"><img width="560" src="https://i.imgur.com/6Gjb6Gz.png" /></a>
 
 > A super intuitive doc generator from Markdown files
 
@@ -17,7 +17,7 @@ documentor init  # initialisation of the documentation
 ```
 
 ```bash
-documentor ./myName -o output.html  # render the documentation to output.html
+documentor ./docs-folder -o output.html  # render the documentation to output.html
 ```
 
 # [Documentation](http://bafs.github.io/Documentor)

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "documentor",
-  "version": "0.0.5",
+  "version": "0.1.0",
   "description": "Documentation generator",
   "main": "src",
   "license": "MIT",