diff options
| author | Tim Smith <tsmith@chef.io> | 2018-10-23 18:56:44 -0700 |
|---|---|---|
| committer | Tim Smith <tsmith@chef.io> | 2018-10-23 18:56:44 -0700 |
| commit | 1fb606af834f6d01e1c225712f8283a883766e63 (patch) | |
| tree | 40ccb23754318cbaf5f5e659a5d2de8a5e021d43 | |
| parent | f8e749876111e632ac926c0c95b52ed9e55fa992 (diff) | |
| download | wmi-lite-1fb606af834f6d01e1c225712f8283a883766e63.tar.gz | |
Move contributing information to the readme
Signed-off-by: Tim Smith <tsmith@chef.io>
| -rw-r--r-- | CHANGELOG.md | 6 | ||||
| -rw-r--r-- | CONTRIBUTING.md | 5 | ||||
| -rw-r--r-- | README.md | 34 |
3 files changed, 23 insertions, 22 deletions
diff --git a/CHANGELOG.md b/CHANGELOG.md index 1651ff8..672042b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,10 +1,6 @@ # WMI-Lite Change Log -## Unreleased -* Initial implementation - -Last Release: v1.0.0 (2014-05-15) -------------------- +## [v1.0.0](https://github.com/chef/wmi-lite/tree/v1.0.0) (2014-05-15) - First public release diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index 0849724..0000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,5 +0,0 @@ -# Contributing to WMI-Lite - -We are glad you want to contribute to WMI-Lite. Please see contribution guidelines for -[Chef](https://docs.chef.io/community_contributions.html) for information on contributing to this project. - @@ -1,5 +1,4 @@ -Wmi-Lite -======== +# Wmi-Lite [](https://travis-ci.org/chef/wmi-lite) [](https://badge.fury.io/rb/wmi-lite) @@ -9,15 +8,14 @@ Wmi-Lite functionality on Windows. It has no dependencies outside of the Ruby interpreter and libraries and of course the Windows operating system. -Installation ------------- +## Installation To install it, run: gem install wmi-lite -Usage ------ +## Usage + To use `wmi-lite` in your Ruby source code, just `require` it: ```ruby @@ -93,13 +91,25 @@ end puts ``` -License & Authors ------------------ -Author:: Adam Edwards (<adamed@chef.io>) -Copyright:: Copyright (c) 2014-2015 Chef Software, Inc. -License:: Apache License, Version 2.0 +## Development Documentation + +All documentation is written using YARD. You can generate a by running: + +``` +rake docs +``` + +## Contributing +For information on contributing to this project please see our [Contributing Documentation](https://github.com/chef/chef/blob/master/CONTRIBUTING.md) + +## License & Copyright + +- Copyright:: Copyright (c) 2014-2018 Chef Software, Inc. +- License:: Apache License, Version 2.0 + +```text Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at @@ -111,4 +121,4 @@ distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. - +``` |