summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJade Dominguez <plusjade@gmail.com>2011-12-30 14:17:44 -0800
committerJade Dominguez <plusjade@gmail.com>2012-01-11 15:13:40 -0800
commit4c18e3c136bea49e3335ab594ae22d999892cf27 (patch)
tree6ee24ea94d767bc6c69081531350a6776a5f9fcb /README.md
version 0.0.1
Diffstat (limited to 'README.md')
-rw-r--r--README.md41
1 files changed, 41 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..67305ee
--- /dev/null
+++ b/README.md
@@ -0,0 +1,41 @@
+# Jekyll-Bootstrap
+
+This is a clean install of the core Jekyll Bootstrap framework you can clone and run your Jekyll blog with.
+
+Jekyll-bootstrap is the quickest and most hassle-free way to get your new Jekyll powered website up and running.
+100% compatible with GitHub pages.
+
+## Usage
+
+For all usage and documentation please see: <http://jekyllbootstrap.com>
+
+## Version
+
+0.0.1 - stable but not versioned.
+
+This version is stable and readily deployable to GitHub Pages and production Jekyll installs.
+However, please expect fast updates that are not backwards compatible with older installs.
+When development reaches 0.1.0, version compatibility between releases will be respected.
+
+## Development
+
+Development is active!
+
+## 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.
+ Please fork and contribute additions to the framework itself here.
+
+- **Jekyll-Bootstrap Documentation Website.**
+ The documentation website at <http://jekyllbootstrap.com> 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!
+
+
+## License
+
+[Creative Commons](http://creativecommons.org/licenses/by-nc-sa/3.0/)