From 4268430bc4c5e4190c66b9c993ea1f2bfca698db Mon Sep 17 00:00:00 2001 From: jeffreytse Date: Sun, 12 Jul 2020 21:02:28 +0800 Subject: [PATCH] docs: update README.md --- README.md | 20 +++++++++++--------- 1 file changed, 11 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index d3e0ccf..3dca55f 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,12 @@ # jekyll-theme-yat +Hey, nice to meet you, you found this Jekyll theme. Here the yet another theme is a modern theme, and it's quiet clear, clean and neat for writers and posts. -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`. -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 + demo-screenshot +

## Installation @@ -33,10 +34,6 @@ Or install it yourself as: TODO: Write usage instructions here. Describe your available layouts, includes, sass and/or assets. -## Contributing - -Bug reports and pull requests are welcome on GitHub at https://github.com/jeffreytse/jekyll-theme-yat. 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`. @@ -46,7 +43,12 @@ Your theme is setup just like a normal Jekyll site! To test your theme, run `bun When your theme is released, only the files in `_data`, `_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 `jekyll-theme-yat.gemspec` accordingly. +## Contributing + +Issues and Pull Requests are greatly appreciated. If you've never contributed to an open source project before I'm more than happy to walk you through how to create a pull request. + +You can start by [opening an issue](https://github.com/jeffreytse/jekyll-theme-yat/issues/new) describing the problem that you're looking to resolve and we'll go from there. + ## License -The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT). - +This theme is licensed under the [MIT license](https://opensource.org/licenses/mit-license.php) © JeffreyTse.