Add README.md

kuoa · Aug 16, 2016 · 978286b · 978286b
1 parent f92c207
commit 978286b
Show file tree

Hide file tree

Showing 3 changed files with 58 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,53 @@
+# Julia [![Demo](https://img.shields.io/badge/julia-demo-green.svg)](http://kuoa.github.io)
+
+A minimalistic jekyll theme
+
+---------------------------
+Home page
+
+![about-page](https://raw.githubusercontent.com/kuoa/julia/master/assets/home.png)
+---------------------------
+
+Part one of a long post
+![post-1](https://raw.githubusercontent.com/kuoa/julia/master/assets/post_1.png)
+---------------------------
+
+Part two of a long post
+![post-2](https://raw.githubusercontent.com/kuoa/julia/master/assets/post_2.png)
+---------------------------
+
+Posts will be listed by category in the `Archive` page alongside with their tags
+![archive-page](https://raw.githubusercontent.com/kuoa/julia/master/assets/archive.png)
+
+---------------------------
+
+How to use it
+=========
+
+
+### Install from github
+
+1. [Fork this repository](https://github.com/kuoa/julia/fork)
+
+2. Clone the repository to your computer and run it
+
+    ``` sh
+    $ git clone https://github.com/kuoa/julia.git
+    $ bundler install
+    $ jekyll serve
+    ```
+
+---------------------------
+
+### Configurations
+Edit the `_config.yml` file and make the theme yours.
+ * Change the base color in */css/main.sccs*  ```$brand-color:      new-color;```
+ * To enable comments modify the ```disqus_shortname```
+ * To enable google-analytics set ```google-analytics``` to true and paste your tracking code in ```/_inludes/google_analytics.html```
+ * To add links to the navbar edit the ```links``` section
+
+---------------------------
+### Author  [![Twitter](https://img.shields.io/badge/kuoa-<3-66BAB7.svg)](https://github.com/kuoa)
+
+---------------------------
+### License  [![License](https://img.shields.io/npm/l/express.svg)](https://github.com/kuoa/julia/blob/master/LICENSE)
diff --git a/_posts/2016-07-22-sample-post.md b/_posts/2016-07-22-sample-post.md
@@ -26,8 +26,10 @@ Below is just about everything you'll need to style in the theme. Check the sour
 
 Lorem ipsum dolor sit amet, test link adipiscing elit. **This is strong**. Nullam dignissim convallis est. Quisque aliquam.
 
-![Smithsonian Image]({{ site.url }}/images/3953273590_704e3899d5_m.jpg)
-{: .image-right}
+This is a image.
+
+![panda]({{ site.url }}/assets/logo.png)
+
 
 *This is emphasized*. Donec faucibus. Nunc iaculis suscipit dui. 53 = 125. Water is H<sub>2</sub>O. Nam sit amet sem. Aliquam libero nisi, imperdiet at, tincidunt nec, gravida vehicula, nisl. The New York Times <cite>(That’s a citation)</cite>. <u>Underline</u>. Maecenas ornare tortor. Donec sed tellus eget sapien fringilla nonummy. Mauris a ante. Suspendisse quam sem, consequat at, commodo vitae, feugiat in, nunc. Morbi imperdiet augue quis tellus.
 

diff --git a/about.md b/about.md
@@ -5,5 +5,5 @@ permalink: /about/
 ---
 **Hi i'm kuoa!** and here is the place where i document and share my projects.
 
-* Github: http://github.com/kuoa
+* [Github](http://github.com/kuoa)
 * Mail: kuoacat[at]gmail[dot]com