diff --git a/README.md b/README.md index 70386069e8..b1eac92c68 100644 --- a/README.md +++ b/README.md @@ -1,45 +1,27 @@ -# Jekyll-Bootstrap +# Jekyll-Bootstrap-3 -The quickest way to start and publish your Jekyll powered blog. 100% compatible with GitHub pages +Easily publish Bootstrap 3 powered Jekyll sites. +Fork of the well known jekyll-bootstrap (v0.3.0). Original project is [here](https://github.com/plusjade/jekyll-bootstrap). +The quickest way to start and publish your Jekyll powered blog. 100% compatible with GitHub pages. ## Usage -For all usage and documentation please see: - -## Version - -0.3.0 - stable and versioned using [semantic versioning](http://semver.org/). - -**NOTE:** 0.3.0 introduces a new theme which is not backwards compatible in the sense it won't _look_ like the old version. -However, the actual API has not changed at all. -You might want to run 0.3.0 in a branch to make sure you are ok with the theme design changes. - -## Contributing - -This repository tracks 2 projects: - -- **Jekyll-Bootstrap Framework.** - The framework for which users should clone and build their blog on top of is available in the master branch. - - To contribute to the framework please make sure to checkout your branch based on `jb-development`!! - This is very important as it allows me to accept your pull request without having to publish a public version release. - - Small, atomic Features, bugs, etc. - Use the `jb-development` branch but note it will likely change fast as pull requests are accepted. - Please rebase as often as possible when working. - Work on small, atomic features/bugs to avoid upstream commits affecting/breaking your development work. - - For Big Features or major API extensions/edits: - This is the one case where I'll accept pull-requests based off the master branch. - This allows you to work in isolation but it means I'll have to manually merge your work into the next public release. - Translation : it might take a bit longer so please be patient! (but sincerely thank you). - -- **Jekyll-Bootstrap Documentation Website.** - The documentation website at is maintained in the gh-pages branch. - Please fork and contribute documentation additions to this branch only. - -The master and gh-pages branch do not share the same ancestry. Please treat them as completely separate git repositories! - +### 1. Create a Repo +- Go to and create a new repository named *USERNAME.github.com* + +### 2. Install Jekyll-Bootstrap-3 +
+  
+    $ git clone https://github.com/dbtek/jekyll-bootstrap-3 USERNAME.github.com
+    $ cd USERNAME.github.com
+    $ git remote set-url origin git@github.com:USERNAME/USERNAME.github.com.git
+    $ git push origin master  
+  
+
+### 3. Enjoy ! +- After giving 10 mins to GitHub of course. + +For original project's usage and documentation please see: ## License