diff --git a/meteor/README.md b/meteor/README.md index 83f49becd..c4f742e73 100644 --- a/meteor/README.md +++ b/meteor/README.md @@ -1,12 +1,38 @@ -Packaging Semantic-UI for [Meteor.js](http://meteor.com), the most popular full-stack JavaScript framework on GitHub. +[Semantic-UI](http://semantic-ui.com/) packaged for [Meteor.js](http://meteor.com). -# Meteor +# Usage -If you're new to Meteor, here's what the excitement is all about - [watch the first two minutes](https://www.youtube.com/watch?v=fsi0aJ9yr2o); you'll be hooked by 1:28. +```sh +meteor add semantic:ui +``` -That screencast is from 2012. In the meantime, Meteor has become a mature JavaScript-everywhere web development framework with numerous [advantages](http://www.meteorpedia.com/read/Why_Meteor) over all other single-page application frameworks. +# Theming + +In case you wish to build your own theme you should follow the +[Recommended Usage (Themed)](https://github.com/Semantic-Org/Semantic-UI#recommended-usage-themed) +guide. + +After having build the project you'll get a ready to use meteor package +shipping your newly created theme. +Simply move the whole folder (or otherwise simlink it...) under your Meteor +app's `packages` folder run + +```sh +meteor add semantic:ui +``` + +from your app's main folder and that's it! -# WIP +# Issues -This is only a stub file... \ No newline at end of file +If you encounter a Meteor-related issue while using this package, +please CC @Semantic-Org/meteor when you +[file it](https://github.com/Semantic-Org/Semantic-UI/issues). + + +# Meteor + +If you're new to Meteor, here's what the excitement is all about - [watch the first two minutes](https://www.youtube.com/watch?v=fsi0aJ9yr2o); you'll be hooked by 1:28. + +That screencast is from 2012. In the meantime, Meteor has become a mature JavaScript-everywhere web development framework with numerous [advantages](http://www.meteorpedia.com/read/Why_Meteor) over all other single-page application frameworks.