From d8ac69582731fc4d0f663be6c8c62aaf4371c6d3 Mon Sep 17 00:00:00 2001 From: Tim Smith Date: Mon, 30 Jul 2018 15:36:35 -0700 Subject: Add docs / contributing section to the readme Signed-off-by: Tim Smith --- README.md | 18 +++++++++++++++--- 1 file changed, 15 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index b777b18..6dd314b 100644 --- a/README.md +++ b/README.md @@ -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 -- cgit v1.2.1