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.

Sign up for GitHub

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

Jump to bottom

clarifying the readme #1244

Merged
merged 8 commits into from
Aug 7, 2019
Merged

clarifying the readme #1244

Changes from 4 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
07f0a14
clarifying the readme
arschles May 27, 2019
7292f08
Merge branch 'master' into public-prox
arschles May 27, 2019
0f74430
Merge branch 'master' into public-prox
arschles May 28, 2019
f3d6df8
Merge branch 'master' into public-prox
arschles Jul 8, 2019
2f2248c
Merge branch 'master' into public-prox
arschles Aug 5, 2019
c54eeea
Bolding "experimental" and providing the experimental proxy URL
arschles Aug 5, 2019
8c40cb1
Merge branch 'master' into public-prox
arschles Aug 6, 2019
5b6106b
Merge branch 'master' into public-prox
marpio Aug 7, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ We encourage you to [try it out](https://docs.gomods.io/install/), let us know w

The proxy implements the [Go modules download protocol](https://docs.gomods.io/intro/protocol/).

There is currently an experimental public proxy, and we have plans to host a more stable public proxy with more guarantees. We also have a community of folks using Athens inside their organizations as an internal proxy. In either deployment, developers set their `GOPROXY` environment variable to point to the Athens proxy of their choice. At that point, `go get`, `go build`, and `go build`s will use the proxy to download dependencies as necessary.
There is currently an experimental public proxy that you can use to try out Athens, without installing anything locally. We also have a community of folks using Athens in production inside their organizations as an internal proxy. In either deployment, developers set their `GOPROXY` environment variable to point to the Athens proxy of their choice. At that point, `go get`, `go build`, `go build`, and more commands will use the proxy to download dependencies as necessary.
Copy link
Member

Choose a reason for hiding this comment

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

We should mark the word experimental somehow (bold?) to make it clear.
Also go build repeats twice.


Athens proxies are highly configurable, so they can work for lots of different deployments. For example, proxies support a wide variety of storage drivers including:

Expand Down