README.md

   1 # Jekyll-Bootstrap
   2
   3 The quickest way to start and publish your Jekyll powered blog. 100% compatible with GitHub pages
   4
   5 ## Usage
   6
   7 For all usage and documentation please see: <http://jekyllbootstrap.com>
   8
   9 ## Version
  10
  11 0.3.0 - stable and versioned using [semantic versioning](http://semver.org/).
  12
  13 **NOTE:** 0.3.0 introduces a new theme which is not backwards compatible in the sense it won't _look_ like the old version.
  14 However, the actual API has not changed at all.
  15 You might want to run 0.3.0 in a branch to make sure you are ok with the theme design changes.
  16
  17 ## Milestones
  18
  19 [0.4.0](https://github.com/plusjade/jekyll-bootstrap/milestones/v%200.4.0) - next release [ETA 03/29/2015]
  20
  21 ### GOALS
  22
  23 * No open PRs against master branch.
  24 * Squash some bugs.
  25 * Add some new features (low-hanging fruit).
  26 * Establish social media presence.
  27
  28
  29 ### Bugs
  30
  31 |Bug |Description
  32 |------|---------------
  33 |[#86](https://github.com/plusjade/jekyll-bootstrap/issues/86)  |&#x2611; Facebook Comments
  34 |[#113](https://github.com/plusjade/jekyll-bootstrap/issues/113)|&#x2611; ASSET_PATH w/ page & post
  35 |[#144](https://github.com/plusjade/jekyll-bootstrap/issues/144)|&#x2610; BASE_PATH w/ FQDN
  36 |[#227](https://github.com/plusjade/jekyll-bootstrap/issues/227)|&#x2611; Redundant JB/setup
  37
  38 ### Features
  39
  40 |Bug |Description
  41 |------|---------------
  42 |[#98](https://github.com/plusjade/jekyll-bootstrap/issues/98)  |&#x2611; GIST Integration
  43 |[#244](https://github.com/plusjade/jekyll-bootstrap/issues/244)|&#x2611; JB/file_exists Helper
  44 |[#42](https://github.com/plusjade/jekyll-bootstrap/issues/42)  |&#x2611; Sort collections of Pages / Posts
  45 |[#84](https://github.com/plusjade/jekyll-bootstrap/issues/84)  |&#x2610; Detecting production mode
  46
  47 ### TODOS
  48
  49 Review existing pull requests against plusjake/jekyll-bootstrap:master. Merge or close each.
  50
  51 * Create twitter account. Add link / icon on jekyllbootstrap.com.
  52 * Create blog posts under plusjade/gh-pages, expose on jekyllbootstrap.com, feed to twitter account.
  53 * Announce state of project, announce roadmap(s), announce new versions as they’re released.
  54
  55 ## Contributing
  56
  57
  58 To contribute to the framework please make sure to checkout your branch based on `jb-development`!!
  59 This is very important as it allows me to accept your pull request without having to publish a public version release.
  60
  61 Small, atomic Features, bugs, etc.
  62 Use the `jb-development` branch but note it will likely change fast as pull requests are accepted.
  63 Please rebase as often as possible when working.
  64 Work on small, atomic features/bugs to avoid upstream commits affecting/breaking your development work.
  65
  66 For Big Features or major API extensions/edits:
  67 This is the one case where I'll accept pull-requests based off the master branch.
  68 This allows you to work in isolation but it means I'll have to manually merge your work into the next public release.
  69 Translation : it might take a bit longer so please be patient! (but sincerely thank you).
  70
  71 **Jekyll-Bootstrap Documentation Website.**
  72
  73 The documentation website at <http://jekyllbootstrap.com> is maintained at https://github.com/plusjade/jekyllbootstrap.com
  74
  75
  76 ## License
  77
  78 [MIT](http://opensource.org/licenses/MIT)