Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add execution example and mention optional env #173

Merged
merged 1 commit into from
Mar 15, 2017

Conversation

ABaldwinHunter
Copy link
Contributor

@ABaldwinHunter ABaldwinHunter commented Feb 3, 2017

Thought this usage section would be useful to have. We don't mention the env var anywhere in README or our docs.

@maxjacobson
Copy link
Contributor

We used to have more details like this, but moved it into our centralized docs: 59b4668

We could keep these details in the README as well, we just have to be conscientious about keeping everything up-to-date, which is easier when things are centralized on the docs. WDYT?

@ABaldwinHunter
Copy link
Contributor Author

we just have to be conscientious about keeping everything up-to-date, which is easier when things are centralized on the docs. WDYT?

I think the invocation and env vars have a low enough churn that having that info in readme wouldn't hurt - and follows the strategy of a lot of other open source tools.

I also believe we don't have mention of the CODECLIMATE_API_HOST in the docs, though I imagine that's less frequently used.

Agree that moving info out of the README seems like a conscious decision though - just wanted to revisit!

Copy link
Contributor

@maxjacobson maxjacobson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK this LGTM - I think it's pretty clear from the structure of the document that the docs are still the place to go for beyond-basic-usage information

@maxjacobson
Copy link
Contributor

@ABaldwinHunter ping

@dblandin
Copy link
Contributor

CODECLIMATE_API_HOST is mentioned in the Code Climate: Enterprise docs: https://docs.codeclimate.com/docs/enterprise-setting-up-test-coverage

@dblandin dblandin merged commit 97c658b into master Mar 15, 2017
@dblandin dblandin deleted the abh-update-readme-instructions branch March 15, 2017 00:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants