diff options
| author | Tim Smith <tsmith@chef.io> | 2018-07-30 15:36:35 -0700 |
|---|---|---|
| committer | Tim Smith <tsmith@chef.io> | 2018-07-30 15:36:35 -0700 |
| commit | d8ac69582731fc4d0f663be6c8c62aaf4371c6d3 (patch) | |
| tree | 27348f4b73574d0477e57d8ba06f557387a9214c | |
| parent | 45766f7df3a9858a8071a5b23d97882534419898 (diff) | |
| download | mixlib-authentication-d8ac69582731fc4d0f663be6c8c62aaf4371c6d3.tar.gz | |
Add docs / contributing section to the readme
Signed-off-by: Tim Smith <tsmith@chef.io>
| -rw-r--r-- | README.md | 18 |
1 files changed, 15 insertions, 3 deletions
@@ -3,9 +3,21 @@ Mixlib::Authentication provides a class-based header signing authentication object, like the one used in Chef. -## License -- Author:: Christopher Brown ([cb@chef.io](mailto:cb@chef.io)) -- Copyright:: Copyright (c) 2009-2016 Chef Software, Inc. +## 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) 2009-2018 Chef Software, Inc. - License:: Apache License, Version 2.0 ```text |