Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
joejoinerr committed Oct 28, 2017
1 parent 8e17511 commit 3b1fd0f
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,17 @@ The Tumblr Boilerplate (unofficial) is a fully automated approach to Tumblr them
## Quick start
1. Download the zip archive: <https://github.com/joejoinerr/tumblr-boilerplate/archive/master.zip>
2. Clone the git repo: `git clone https://github.com/joejoinerr/tumblr-boilerplate.git`
3. Run `gulp build` to generate a static version of your theme, or `gulp dist` to generate the final code to paste into the Tumblr theme editor.

## Features
- Automatic concatenation, minification and moving external CSS to a `<style>` tag via [Grunt](http://gruntjs.com)
- Automatic concatenation, minification and moving external CSS to a `<style>` tag via [Gulp](https://gulpjs.com)
- Suggested markup for common post types
- Posts loop in semantic `<article>` tags
- Common and useful `<meta>` tags
- Iterative `<title>` tag
- User variables
- Multi-language support
- OOCSS and BEM suggested class names
- Simple pagination links
- IDs on page sections for easy linking
- Bundled with [Normalize.css](http://necolas.github.com/normalize.css/) via [cdnjs](http://cdnjs.com)

Check out the [Tumblr theme docs](http://www.tumblr.com/docs/en/custom_themes) for information about specific variables or blocks.
Expand All @@ -24,7 +24,9 @@ Check out the [Tumblr theme docs](http://www.tumblr.com/docs/en/custom_themes) f
[Read the Tumblr Boilerplate docs &rarr;](https://github.com/joejoinerr/tumblr-boilerplate/wiki)

## Contribute
If you've got any great features to add to the Tumblr Boilerplate, or if there's a problem with my code, then get involved! This is a side project so I might not be immediately available:
If you've got any great features to add to the Tumblr Boilerplate, or if there's a problem with my code, then get involved!

- File an [issue](https://github.com/joejoinerr/tumblr-boilerplate/issues) stating the bug/feature request *or*
- Fork the repo, add the code yourself and submit a pull request

_This is a side project so I might not be immediately available._

0 comments on commit 3b1fd0f

Please sign in to comment.