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

Improve "Try it" section in README.md #217

Merged
merged 1 commit into from
Oct 6, 2020

Conversation

mik-laj
Copy link
Contributor

@mik-laj mik-laj commented Oct 6, 2020

Hello,

I improved the commands that allow you to run the application:

  • separated running the app and creating a variable with a Github token into two commands. This allows for easier adaptation of the example to a specific use case, e.g. using a token from CLI or copied from a website.
  • mounted configuration file from local filesystem as user will probably want to test this project against their repository, but the location of this file in the container is not obvious
  • added a hint using a token from Github CLI.. If user has Github CLI and Docker, user can run this project with one click 🎉

Best regards,
Kamil Breguła

@mik-laj mik-laj changed the title Add "Try it" section in README.md Improve "Try it" section in README.md Oct 6, 2020
Copy link
Collaborator

@tstromberg tstromberg left a comment

Choose a reason for hiding this comment

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

Looks great!

@tstromberg tstromberg merged commit 7f6f8f0 into google:master Oct 6, 2020
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