From e5bfe213bf87dfea621d2b2716ae5d8b8d41cda7 Mon Sep 17 00:00:00 2001 From: Dennis Hoer Date: Sun, 21 Sep 2014 18:45:49 -0700 Subject: [PATCH] Add license info via osrcry --- CONTRIBUTING.md | 18 ++++++++++++++++++ CONTRIBUTORS.md | 1 + LICENSE.md | 20 ++++++++++++++++++++ README.md | 9 ++++++--- TLDR.md | 16 ++++++++-------- metadata.rb | 2 ++ 6 files changed, 55 insertions(+), 11 deletions(-) create mode 100644 CONTRIBUTING.md create mode 100644 CONTRIBUTORS.md create mode 100644 LICENSE.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..0ad0a5e --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,18 @@ +## Getting Involved + +New contributors are always welcome, when it doubt please ask questions. We strive to be an open and welcoming community. Please be nice to one another. + +### Coding + +* Pick a task: + * Offer feedback on open [pull requests](https://github.com/dhoer/chef-nssm/pulls). + * Review open [issues](https://github.com/dhoer/chef-nssm/issues) for things to help on. + * [Create an issue](https://github.com/dhoer/chef-nssm/issues/new) to start a discussion on additions or features. +* Fork the project, add your changes and tests to cover them in a topic branch. +* Commit your changes and rebase against `dhoer/chef-nssm` to ensure everything is up to date. +* [Submit a pull request](https://github.com/dhoer/chef-nssm/compare/). + +### Non-Coding + +* Offer feedback on open [issues](https://github.com/dhoer/chef-nssm/issues). +* Organize or volunteer at events. diff --git a/CONTRIBUTORS.md b/CONTRIBUTORS.md new file mode 100644 index 0000000..c76bde8 --- /dev/null +++ b/CONTRIBUTORS.md @@ -0,0 +1 @@ +* Dennis Hoer \ No newline at end of file diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..25fff12 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,20 @@ +The MIT License (MIT) + +Copyright (c) 2014 [CONTRIBUTORS](https://github.com/dhoer/chef-nssm/blob/master/CONTRIBUTORS.md) + +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 2fa092c..c74fcc2 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ [![Build Status](https://travis-ci.org/dhoer/chef-nssm.svg)](https://travis-ci.org/dhoer/chef-nssm) This cookbook installs the Non-Sucking Service Manager (http://nssm.cc), and exposes resources to `install` and `remove` Windows services. -Read [TLDR](TLDR.md) for more details about usage, chefspec matchers, and contributing. +Read [TLDR](https://github.com/dhoer/chef-nssm/blob/master/TLDR.md) for more details about usage, chefspec matchers, getting help and contributing. ## Requirements @@ -26,7 +26,7 @@ To install a Windows service: nssm 'service name' do app 'java' args [ - "-jar", + '-jar', "'C:\\path to\\my-executable.jar'" ] action :install @@ -37,4 +37,7 @@ To remove a Windows service: nssm 'service name' do action :remove end - \ No newline at end of file + +## License + +Please refer to [LICENSE](https://github.com/dhoer/chef-nssm/blob/master/LICENSE.md). diff --git a/TLDR.md b/TLDR.md index 1c69261..b16ab9e 100644 --- a/TLDR.md +++ b/TLDR.md @@ -32,14 +32,14 @@ Example Matcher Usage NSSM Cookbook Matchers -- install_nssm_service -- remove_nssm_service +- install_nssm_service(servicename) +- remove_nssm_service(servicename) + +## Getting Help + +- Ask specific questions on [Stack Overflow](http://stackoverflow.com/questions/tagged/chef-nssm). +- Report bugs and discuss potential features in [Github issues](https://github.com/dhoer/chef-nssm/issues). ## Contributing -1. Fork the repository on Github -2. Create a named feature branch (like `add_component_x`) -3. Write your change -4. Write tests for your change (if applicable) -5. Run the tests, ensuring they all pass -6. Submit a Pull Request using Github +Please refer to [CONTRIBUTING](https://github.com/dhoer/chef-nssm/blob/master/CONTRIBUTING.md). diff --git a/metadata.rb b/metadata.rb index 0d587dc..380b515 100644 --- a/metadata.rb +++ b/metadata.rb @@ -6,4 +6,6 @@ long_description IO.read(File.join(File.dirname(__FILE__), 'README.md')) version '0.1.0' +supports 'windows' + depends 'windows'