Update Welcome to Tranquilpeak blog post

README.md

@@ -144,5 +144,5 @@ That mean I would keep a stronge dependency with original *Hexo* theme. Thus if
 
 ## License
 
-hugo-tranquilpeak-theme is released under the terms of the [GNU General Public License v3.0](LICENSE).
+hugo-tranquilpeak-theme is released under the terms of the [GNU General Public License v3.0](https://github.com/kakawait/hugo-tranquilpeak-theme/blob/master/LICENSE).
 

exampleSite/content/post/Welcome-to-the-new-Tranquilpeak.md

@@ -36,6 +36,16 @@ A gorgeous responsive theme for Hugo blog framework
 
 [![Tranquilpeak](/img/showcase.png)](https://tranquilpeak.kakawait.com)
 
+## Alpha/Beta versions
+
+**ATTENTION** during *alpha* or *beta* [versions](https://github.com/kakawait/hugo-tranquilpeak-theme/milestones) breaking changes are possible on config file.
+
+You can track [breaking changes label](https://github.com/kakawait/hugo-tranquilpeak-theme/issues?q=is%3Aissue+is%3Aopen+label%3A%22breaking+changes%22) or simply read [CHANGELOG.md](https://github.com/kakawait/hugo-tranquilpeak-theme/CHANGELOG.md).
+
+Moreover you can use `migrators` from `migrators` folders. Migration scripts will produces a new config file with suffix `.new`, it will not override your current config. Indeed migration scripts will erase any comments and formating, that why migration scripts will not override your config.
+
+Any modifications are printed on output to allow you reproduce/replay migrations on your own config file manually.
+
 ## Credits
 
 *Hugo* version of Tranquilpeak is a based on original *Hexo* version https://github.com/LouisBarranqueiro/hexo-theme-tranquilpeak. This version is simply a port to *Hugo* static site generator.
@@ -59,7 +69,7 @@ Please all the credit should be attributed to [original *Hexo* version](https://
 
 - **Authors**: [Louis Barranqueiro (LouisBarranqueiro)](https://github.com/LouisBarranqueiro) and [Thibaud Leprêtre (kakawait)](https://github.com/kakawait)
 - **Version**: 0.1.0-ALPHA (based on Hexo version 1.9.1)
-- **Compatibility**: Hugo v0.16
+- **Compatibility**: Hugo v0.17
 
 ## Features
 
@@ -73,6 +83,7 @@ Please all the credit should be attributed to [original *Hexo* version](https://
 - Beautiful about page
 - Support Open Graph protocol
 - Easily customizable (fonts, colors, layout elements, code coloration, etc..)
+- Documentations
 
 **Posts features:**  
 
@@ -93,13 +104,13 @@ Please all the credit should be attributed to [original *Hexo* version](https://
 - Gravatar
 - Facebook Insights
 
-### Todo of missing features from original *Hexo* version
+### Missing features from original *Hexo* version
 
-- [ ] Support internationalization (i18)
+- [ ] Support internationalization (i18) (https://github.com/kakawait/hugo-tranquilpeak-theme/issues/9)
 - [ ] Duoshuo
 - [ ] Baidu analytics
-- [ ] Algolia
-- [ ] Documentations
+- [ ] Algolia (https://github.com/kakawait/hugo-tranquilpeak-theme/issues/8)
+- [ ] Pagination custumization `tag_pagination`, `category_pagination` and `archive_pagination` (https://github.com/kakawait/hugo-tranquilpeak-theme/issues/17)
 
 **ATTENTION** following features will not be possible due to *Hugo* limitations
 
@@ -108,17 +119,47 @@ Please all the credit should be attributed to [original *Hexo* version](https://
 
 ## Quick start
 
-Coming soon (see https://github.com/kakawait/hugo-tranquilpeak-theme/issues/4)
+**Please read [user documentation](https://github.com/kakawait/hugo-tranquilpeak-theme/blob/master/docs/user.md), it's short and useful to discover all features and possibilities of the theme, especially the  [writing posts](https://github.com/kakawait/hugo-tranquilpeak-theme/blob/master/docs/user.md#writing-posts) section**
+
+##### For people who want to use the original version of Tranquilpeak without modifications (users)
+
+Go to the directory where you have your Hugo site and run:
+
+```shell
+mkdir themes
+cd themes
+git clone https://github.com/kakawait/hugo-tranquilpeak-theme.git
+```
+
+After installing the Tranquilpeak theme successfully, we recommend you to take a look at the [exampleSite](exampleSite) directory. You will find a working Hugo site configured with the Universal theme that you can use as a starting point for your site.
+
+First, let's take a look at the [config.toml](exampleSite/config.tom). It will be useful to learn how to customize your site. Feel free to play around with the settings.
+
+More information on [user documentation](https://github.com/kakawait/hugo-tranquilpeak-theme/blob/master/docs/user.md) to install and configure the theme  
+
+##### For people who want to create their own version of tranquilpeak (developers) 
+
+1. Run `git clone https://github.com/kakawait/hugo-tranquilpeak-theme.git`  
+2. Follow [developer documentation](https://github.com/kakawait/hugo-tranquilpeak-theme/blob/master/docs/developer.md) to edit and build the theme 
 
 ## Demo
 
-Coming soon (see https://github.com/kakawait/hugo-tranquilpeak-theme/issues/3)
+Check out Tranquilpeak theme in live : [hugo-tranquilpeak-theme demo](https://tranquilpeak.kakawait.com)
 
 ## Showcase
 
-I would like to create a showcase with all blogs that use Tranquilpeak, please, add your blog into.  
+Checkout showcase https://github.com/kakawait/hugo-tranquilpeak-theme/wiki/Showcase
+
+### How can I add my site to the showcase
+
 **Click [here](https://github.com/kakawait/hugo-tranquilpeak-theme/issues/new?title=Add%20my%20blog%20into%20the%20showcase&body=Hey,%20add%20my%20blog%20into%20the%20showcase:) to add your blog into the showcase.**
 
+Please fill the following information:
+
+1. public url
+2. name (optional)
+3. description (optional)
+
 ## Documentation
 
 Coming soon (see https://github.com/kakawait/hugo-tranquilpeak-theme/issues/4)
@@ -137,3 +178,4 @@ That mean I would keep a stronge dependency with original *Hexo* theme. Thus if
 
 hugo-tranquilpeak-theme is released under the terms of the [GNU General Public License v3.0](https://github.com/kakawait/hugo-tranquilpeak-theme/blob/master/LICENSE).
 
+