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 configurations file and improve README #2

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

techytushar
Copy link

I have added a configurations file so that the users can easily set the environment variables and also made some changes to the README

Copy link
Contributor

@judy2k judy2k left a comment

Choose a reason for hiding this comment

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

Thanks for this contribution - I like it!

Just one minor change in the README, and then I'll be happy to merge.

README.md Outdated
@@ -13,12 +13,14 @@ pipenv shell

## Running It:

To run it you'll need to set the following environment variables, either directly, or using Foreman or Envdir:
To run it you'll need to set the following environment variables. This can be done by running `source config.env` or using Foreman or Envdir:
Copy link
Contributor

Choose a reason for hiding this comment

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

Please could you make it clearer in this sentence that they need to modify config.env before sourcing it?

@techytushar
Copy link
Author

hey @judy2k, I have updated the changes, please have a look 🙂

@mheap mheap changed the base branch from master to main February 1, 2021 13:47
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.

2 participants