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

Tweaks/fixes to README #2

Merged
merged 4 commits into from
Jul 15, 2020
Merged

Tweaks/fixes to README #2

merged 4 commits into from
Jul 15, 2020

Conversation

FishNecks
Copy link
Contributor

Improve documentation for first-time users. 🌚

@FishNecks FishNecks requested a review from fishnix July 2, 2020 20:43
Copy link
Contributor

@fishnix fishnix 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 the updates!

README.md Outdated
@@ -4,6 +4,8 @@ A simple token management tool.

## Usage

Note that for all commands below you will need to replace `toker` with `go run main.go` unless you've compiled the code into a binary named `toker`. Before running, you may need to run `rm go.sum;go get -u ./...`
Copy link
Contributor

Choose a reason for hiding this comment

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

Before running, you may need to run rm go.sum;go get -u ./...``

This shouldn't be true, I'm not sure why you ran into those issues. You could enumerate the steps though, which would be (at a high level):

git clone ....
cd toker
go get ./...
alias toker="go run main.go"
toker help

@FishNecks FishNecks merged commit 55f5dfc into master Jul 15, 2020
@FishNecks FishNecks deleted the ag-documentation-tweaks branch July 15, 2020 18:26
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