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 GoDoc Usage instructions in the homepage #52

Closed
tiero opened this issue May 22, 2020 · 2 comments
Closed

Add GoDoc Usage instructions in the homepage #52

tiero opened this issue May 22, 2020 · 2 comments
Projects

Comments

@tiero
Copy link
Member

tiero commented May 22, 2020

Describe how a Go developer should import the library (eg. go get) and some highlight on how to generate and address etc.. in the main Readme

@altafan
Copy link
Collaborator

altafan commented May 22, 2020

Is it enough to add a link in the readme pointing to the example?

@tiero
Copy link
Member Author

tiero commented May 22, 2020

still would be missing installing instructions. I think some main functions in the Readme in markdown could be nice.

Thax example.go file would be used by the godoc pkg documentation we'll build

@tiero tiero added this to Needs triage in v0.0.4 May 27, 2020
@tiero tiero moved this from Needs triage to Low priority in v0.0.4 May 28, 2020
@tiero tiero changed the title Add Usage instructions Add GoDoc Usage instructions in the homepage Jun 10, 2020
@tiero tiero moved this from Low priority to Needs triage in v0.0.4 Jun 15, 2020
@tiero tiero closed this as completed Feb 25, 2021
v0.0.4 automation moved this from Needs triage to Closed Feb 25, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
v0.0.4
  
Closed
Development

No branches or pull requests

2 participants