Documentation updates

.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,73 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+education, socio-economic status, nationality, personal appearance, race,
+religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at <github@clburlison.com>. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org

.github/CONTRIBUTING.md

@@ -0,0 +1,56 @@
+# Contributing Guide
+
+**Working on your first Pull Request?** You can learn how from this *free*
+series [How to Contribute to an Open Source Project on GitHub][First PR]
+
+## Major changes
+
+Prior to starting work on a major change please open an [issue][]. This allows
+you to connect with a maintainer to verify that your change will get merged
+upstream. Doing so might save you a lot of wasted effort.
+
+## How to contribute
+
+* Fork the project from the `master` branch and submit a Pull Request (PR)
+  * Explain what the PR fixes or improves
+* Use sensible commit messages
+  * If your PR fixes a separate issue number, include it in the commit message
+* Use a sensible number of commits as well
+  * e.g. Your PR should not have 100s of commits
+
+## Things to keep in mind
+
+* Smaller Pull Requests are likely to be merged more quickly than bigger changes
+* This project is using a [KISS Workflow][]
+  * Pull Requests and bugfixes are directly merged into `master` after sanity testing
+  * `master` is considered the main developer branch
+  * the version tags are considered stable and frozen
+* This project is using [Semantic Versioning 2.0.0](http://semver.org/)
+  * If a bugfix or PR is *not* trivial it will likely end up in the next **MINOR** version
+  * If a bugfix or PR *is* trivial *or* critical it will likely end up in the next **PATCH** version
+* Some tests are OS specific
+
+## Commit messages
+
+* Squashing to 1 commit is **not** required at this time
+* Use sensible commit messages (when in doubt: `git log`)
+* Use a sensible number of commit messages
+* If your PR fixes a specific issue number, include it in the commit message: `"Fixes XYZ error (fixes #123)"`
+
+## Code standards
+
+* Try to follow [Effective Go Style Guide][]
+* For all new code try to include an effective test
+* Lint and test code
+  * `make lint`
+  * `make test`
+
+_This file was based off work from [Ryan L McIntyre][contributing_ref]_
+
+<!-- link references -->
+
+[issue]: https://github.com/clburlison/bakeit/issues
+[KISS Workflow]: https://en.wikipedia.org/wiki/KISS_principle
+[Effective Go Style Guide]: https://en.wikipedia.org/wiki/KISS_principle
+[First PR]: https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github
+[contributing_ref]: https://github.com/ryanoasis/nerd-fonts/blob/1.2.0/contributing.md

README.md

@@ -1,27 +1,89 @@
-# bakeit [![CircleCI](https://circleci.com/gh/clburlison/bakeit.svg?style=svg&circle-token=e56e3ca96a10956ff58dc8f504601d28778cb7c2)](https://circleci.com/gh/clburlison/bakeit)
+# bakeit
 
-### Overview
+[![CircleCI][img-circleci-badge]][cirlce-ci]
+[![PRs Welcome][img-prs-welcome-badge]][prs-welcome]
 
-bakeit is designed to be a platform agnostic chef bootstrap tool. Unlike `knife bootstrap`, bakeit is written to be ran on end points.
+`bakeit` is a platform agnostic chef bootstrap tool. Unlike `knife bootstrap`,
+bakeit is written for end points not servers. All required configuration
+data is compiled into a single static binary that can be ran on the end point
+for bootstrapping.
 
-### Requirements
+## Table of Contents
 
-1. [Go 1.9](https://golang.org/dl/)
-1. Chef validator key
+* [**Features**](#features)
+* [**Basic Usage**](#basic-usage)
+* [**Developers**](#developers)
+* [**Changelog**](#changelog)
+* [**License**](#license)
 
-### Building
+## Features
 
-```bash
-# if GOPATH is unset:
-# export GOPATH=$(HOME)/go
+* No extra dependencies necessary on your end points
+* Shared code between each platform where possible
+* One file holds all configuration settings
+* Works on Mac, Linux (coming soon) and Windows
 
-# Clone the repo into GOPATH:
-git clone git@github.com:clburlison/bakeit $GOPATH/src/github.com/clburlison/bakeit
-cd $GOPATH/src/github.com/clburlison/bakeit
+## Basic Usage
 
-# Download dependencies and build:
-make deps
-make
-```
+This section is designed for users new to the Go ecosystem that just want to
+build and use this project.
 
-* More Info on [`GOPATH`](https://golang.org/doc/code.html#GOPATH)
+1. Download and install [Go 1.9][download-go]
+1. Set required Go variables
+    ```bash
+    export GOPATH=$(go env GOPATH)
+    PATH=$PATH:${GOPATH}/bin
+    ```
+1. Clone this repo
+    ```bash
+    git clone git@github.com:clburlison/bakeit $GOPATH/src/github.com/clburlison/bakeit
+    ```
+1. Download dependencies
+    ```bash
+    make deps
+    ```
+1. Modify the [config.go][] file. Make sure to modify the following keys:
+    * `ChefClientChefServerURL` - The URL to your chef server
+    * `ChefClientValidationClientName` - The name of your validator file
+    * `ValidationPEM` - The contents of your validator certificate
+    * `OrgCert` - (Optional) The contents of your organization certificate
+1. Build
+    ```bash
+    make build-all
+    ```
+1. Copy the correct output file from build/ to a machine and run it.
+1. Running instructions
+    ```bash
+    # Linux/macOS
+    sudo /path/bakeit
+
+    # Windows. Open a command prompt as administrator
+    /path/bakeit
+    ```
+
+## Developers
+Coming soon!
+<!-- https://golang.org/doc/code.html, https://blog.golang.org/cover -->
+
+## Contributing
+
+See [CONTRIBUTING.md](.github/CONTRIBUTING.md)
+
+## Changelog
+
+See [CHANGELOG.md](CHANGELOG.md)
+
+## License
+
+[MIT](LICENSE) © Clayton Burlison
+
+<!--
+Link References
+-->
+
+[img-circleci-badge]:https://circleci.com/gh/clburlison/bakeit.svg?style=shield&circle-token=e56e3ca96a10956ff58dc8f504601d28778cb7c2
+[img-prs-welcome-badge]:https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat
+[cirlce-ci]:https://circleci.com/gh/clburlison/bakeit
+[prs-welcome]:http://makeapullrequest.com
+[download-go]: https://golang.org/dl/
+[config.go]: https://github.com/clburlison/bakeit/blob/master/src/config/config.go