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

update readme to include all the env var's that are used to configure the server #331

Merged
merged 7 commits into from Jan 12, 2015

Conversation

jasoncalabrese
Copy link
Member

No description provided.

@jasoncalabrese
Copy link
Member Author

good catch @jjmason

@bewest
Copy link
Member

bewest commented Jan 11, 2015

Here is preview link: https://github.com/nightscout/cgm-remote-monitor/blob/wip/readme-env-update/README.md

I added some links to the update-fork, mongostring, and configure tools.
I also created two tables with the things people might be interested in up front and center, clearly marked the one REQUIRED thing, and the rest of the optional things.

@jasoncalabrese
Copy link
Member Author

nice, some of the env's are code other just CAPS
Core should probably be first too

@jasoncalabrese
Copy link
Member Author

I'm going to update now

@bewest
Copy link
Member

bewest commented Jan 12, 2015

Looks ok, I think the labs/features table should be first, based on how often it's likely to be used.
The only one required environment variable is covered in detail in other places, so I'm guessing people are going to want the labs/features table most often.

@jasoncalabrese
Copy link
Member Author

My thinking is that it would help someone get started it they saw the required/core vars first, but you have a good point too. Either way works for me.

@bewest
Copy link
Member

bewest commented Jan 12, 2015

Looks like the code fences make the thing do awful things with the scrollbars.

jasoncalabrese added a commit that referenced this pull request Jan 12, 2015
update readme to include all the env var's that are used to configure the server
@jasoncalabrese jasoncalabrese merged commit 190f66b into dev Jan 12, 2015
@jasoncalabrese jasoncalabrese deleted the wip/readme-env-update branch January 12, 2015 08:21
@coveralls
Copy link

Coverage Status

Changes Unknown when pulling 874c48f on wip/readme-env-update into * on dev*.

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.

None yet

4 participants