Permalink
Browse files

Add license and readme

  • Loading branch information...
mixonic committed Feb 29, 2012
1 parent 41a7193 commit 880b7ddd68b97d0973d3380554ade024dc31f3e1
Showing with 65 additions and 0 deletions.
  1. +7 −0 LICENSE
  2. +58 −0 README.md
View
@@ -0,0 +1,7 @@
+Copyright (c) 2012 Matthew Beale
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
View
@@ -0,0 +1,58 @@
+Spinto Ruby Gem
+---------------
+
+[Spinto](http://www.spintoapp.com) is a CMS alternative for
+building websites with non-technical contributors over Git.
+The site builder on Spinto's server is a flavor
+of [Jekyll](https://github.com/mojombo/jekyll), with added
+support for [CoffeeScript](http://coffeescript.org/),
+[LESS](http://lesscss.org/),
+[SASS and SCSS](http://sass-lang.com/).
+
+The Spinto Ruby Gem comes with a server to build and preview
+your website on your own computer. Open a terminal and `cd`
+into a Spinto/Jekyll project, and start the server:
+
+``` bash
+spinto-server --auto --server
+```
+
+Now you can open a browser to [http://localhost:4000](http://localhost:4000)
+and see your website. The `--auto` flag will ensure your
+website is rebuilt when files are changed.
+
+```
+> spinto-site --help
+Spinto-site is the spintoapp.com wrapper of jekyll,
+the blog-aware, static site generator.
+
+Basic Command Line Usage:
+ spinto-site # . -> ./_site
+ spinto-site <path to write generated site> # . -> <path>
+ spinto-site <path to source> <path to write generated site> # <path> -> <path>
+ spinto-site --auto --server # Host your site locally
+
+ Configuration is read from '<source>/_config.yml' but can be overriden
+ using the following options:
+
+ --[no-]auto Auto-regenerate
+ --server [PORT] Start web server (default port 4000)
+ --no-server Do not start a web server
+ --url [URL] Set custom site.url
+ --version Display current version
+```
+
+**Installation**
+
+``` bash
+gem install barron
+```
+
+And you're done!
+
+**Additional Info**
+
+The Spinto Ruby Gem is available under the MIT License.
+
+Written by [Matthew Beale](matt.beale@madhatted.com) for [Spinto](http://www.spintoapp.com).
+

0 comments on commit 880b7dd

Please sign in to comment.