Skip to content

Commit

Permalink
README: include case sensitive installation (#207)
Browse files Browse the repository at this point in the history
* README: include case sensitive installation

* Update README to include more context
  • Loading branch information
marwan-at-work authored and jprobinson committed Mar 4, 2019
1 parent 2c5fa25 commit c84e1f2
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,17 @@ This toolkit provides packages to put together server and pubsub daemons with th
* Useful metrics for endpoints
* Graceful shutdowns


### Install
Notice the capitalization!

`go get github.com/NYTimes/gizmo/...`

### Import Path Change Notice
The New York Times recently changed the github organization from `NYTimes` to `nytimes`. This should not affect the installation as long as you use the proper casing `NYTimes` and not `nytimes` per installation instructions above.

However, the intention is to migrate the import paths to be consistent with how it's shown on GitHub. This will be a breaking change and we will introduce a major tag when we update the code. Therefore, the import path will go from `github.com/NYTimes/gizmo/server` to `github.com/nytimes/gizmo/v2/server`. This ensures that people will not have type-mismatches between import path changes.

### Packages

#### [`server`](https://godoc.org/github.com/NYTimes/gizmo/server)
Expand Down

0 comments on commit c84e1f2

Please sign in to comment.