Skip to content

Copy docs from a PR to create a USAGE.md file #44

Closed
@mbernier

Description

@mbernier

Issue Summary

Usage files are really nice when they exist in a repo, because it makes it really obvious where to look for information about how to use this tool. It can be frustrating when you expect this file to be there and it's not.
Please add a USAGE.md file, you can see an example of this
here

Please make sure you modify the file for this repo (hint: Most of this information should be in the README file)

Also, @fifiteen82726 put together some AWESOME docs for how to install and run codeclimate locally, including a gif. Please add this to your new USAGE.md file.

Metadata

Metadata

Assignees

No one assigned

    Labels

    difficulty: easyfix is easy in difficultystatus: work in progressTwilio or the community is in the process of implementingtype: docs updatedocumentation change not affecting the code

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions