diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..a71f6de --- /dev/null +++ b/LICENSE @@ -0,0 +1,20 @@ +The MIT License (MIT) + +Copyright (c) 2014 Civilized Discourse Construction Kit, Inc. + +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. diff --git a/README.md b/README.md index 37285db..c79d2c4 100644 --- a/README.md +++ b/README.md @@ -2,12 +2,29 @@ This plugin works with the Discourse docker image. It allows you to perform upgrades via the web UI and monitor activity in the container. -### Development Notes +## Development Notes + +* Install `node.js`, `bower`, `grunt` +* Clone this repo to desired folder path +* In console, from folder path do `cd manger_client`, `npm install`, `bower install` +* Create a symlink for this folder in your local Discourse instance "plugins" folder (eg. path/to/your/discourse_folder/plugins/discourse_manager) +* Make sure your Discourse instance is running locally at port 3000 and you are logged in as Admin +* In development mode, using `grunt server` will proxy to your Discourse instance running on port 3000 +* Just open up a browser to port 8000 and you're off to the races! The client application is built using [Ember App Kit](https://github.com/stefanpenner/ember-app-kit). -In development mode, using `grunt server` will proxy to your Discourse instance running on port 3000. -Just open up a browser to port 8000 and you're off to the races! - To create a compiled version for distribution, run `./compile_client.sh` to compile the site and move it into the proper directories. + +## Contributing + +1. Fork it +2. Create your feature branch (`git checkout -b my-new-feature`) +3. Commit your changes (`git commit -am 'Add some feature'`) +4. Push to the branch (`git push origin my-new-feature`) +5. Create new Pull Request + +## License + +MIT