README.md in jekyll-theme-console-0.1.1 vs README.md in jekyll-theme-console-0.2
- old
+ new
@@ -1,14 +1,10 @@
# jekyll-theme-console
-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`.
+A jekyll theme with inspiration from linux consoles for hackers, developers and script kiddies.
-To experiment with this code, add some sample content and run `bundle exec jekyll serve` – this directory is setup just like a Jekyll site!
-TODO: Delete this and the text above, and describe your gem
-
-
## Installation
Add this line to your Jekyll site's `Gemfile`:
```ruby
@@ -29,15 +25,24 @@
$ gem install jekyll-theme-console
## Usage
-TODO: Write usage instructions here. Describe your available layouts, includes, sass and/or assets.
+In addition to the default configuration options, you can provide header_pages to specify which pages should be displayed in navbar. You can also provide a footer. Find examples below:
+```yaml
+header_pages:
+ - index.md
+ - about.md
+
+footer: 'follow us on <a href="https://twitter.com/xxx">twitter</a>'
+```
+
+
## Contributing
-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.
+Bug reports and pull requests are welcome on GitHub at https://github.com/b2a3e8/jekyll-theme-console. 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.
## Development
To set up your environment to develop this theme, run `bundle install`.
@@ -47,6 +52,5 @@
To add a custom directory to your theme-gem, please edit the regexp in `jekyll-theme-console.gemspec` accordingly.
## License
The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
-