README.md in material-blog-jp-0.2.0 vs README.md in material-blog-jp-0.3.0
- old
+ new
@@ -1,51 +1,56 @@
-# material-blog-jp
+# material-blog-jp (Jekyll Theme)
+Material-blog-jp is a blog build following material design principles. This theme is built using material design lite web framework.
-Welcome to your new Jekyll theme! In this directory, you'll find the files you need to be able to package up your theme into a gem. Put your layouts in `_layouts`, your includes in `_includes`, your sass files in `_sass` and any other assets in `assets`.
+This theme consists of four web pages, index, about, search and 404. Index will display all the blog posts, starting from the latest. Search will display a text field input and two of the latest blog posting. About will contain a description about the blog. 404 will display when someone tried to access a resource that can not be found. This theme is optimized for mobile phones, iPads, etc
-To experiment with this code, add some sample content and run `bundle exec jekyll serve` – this directory is setup just like a Jekyll site!
+Due to some of the limitations, please have at least two posts to push the footers to the bottom of the page, same goes for the "about" section.
-TODO: Delete this and the text above, and describe your gem
+
-
## Installation
+Setup Jekyll in your environment https://jekyllrb.com/docs/installation/windows/
-Add this line to your Jekyll site's `Gemfile`:
+Clone or fork this repository
-```ruby
-gem "material-blog-jp"
-```
+`git clone https://github.com/johnnymythology/material-blog-jp.git`
-And add this line to your Jekyll site's `_config.yml`:
+`gem install material-blog-jp`
-```yaml
-theme: material-blog-jp
-```
+`bundle exec jekyll serve`
-And then execute:
+## Usage
- $ bundle
+There are four default pages:
+- index.md
+- about.md
+- search.md
+- 404.md
-Or install it yourself as:
+Each page has a different title. Edit the title in the Front Matter.
- $ gem install material-blog-jp
+The blog title needs to be edited in _config.yml
+Fill in the options in _config.yml accordingly. This will be used for SEO (Search Engine Optimization).
-## Usage
+To create a new post, follow the naming format in the two example post. Since this blog uses images for each post, select an image and put it inside the assets folder. Follow the naming convention as the two sample image.
-TODO: Write usage instructions here. Describe your available layouts, includes, sass and/or assets.
+## Technical
+Web Framework: Material Design Lite
-## Contributing
+Static Site Generator: Jekyll
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/hello. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Javascript Libraries: jQuery
-## Development
+For search, I am using "simple jekyll search" by Chistian Fei
-To set up your environment to develop this theme, run `bundle install`.
+Material design lite header I am using is not mobile optimized and requires some additional CSS.
-Your theme is setup just like a normal Jekyll site! To test your theme, run `bundle exec jekyll serve` and open your browser at `http://localhost:4000`. This starts a Jekyll server using your theme. Add pages, documents, data, etc. like normal to test your theme's contents. As you make modifications to your theme and to your content, your site will regenerate and you should see the changes in the browser after a refresh, just like normal.
+jQuery is used for the arrow button to scroll the screen back to the top.
-When your theme is released, only the files in `_layouts`, `_includes`, `_sass` and `assets` tracked with Git will be bundled.
-To add a custom directory to your theme-gem, please edit the regexp in `material-design-blog-jp.gemspec` accordingly.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/johnnymythology/material-blog-jp.
## License
The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).