more references and additional details about the internal directory

wingkwong · Sep 28, 2019 · 39bca7d · 39bca7d
1 parent 91f7374
commit 39bca7d
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -39,9 +39,9 @@ See the [`/cmd`](cmd/README.md) directory for examples.
 
 ### `/internal`
 
-Private application and library code. This is the code you don't want others importing in their applications or libraries.
+Private application and library code. This is the code you don't want others importing in their applications or libraries. Note that this layout pattern is enforced by the Go compiler itself. See the Go 1.4 [`release notes`](https://golang.org/doc/go1.4#internalpackages) for more details.
 
-Put your actual application code in the `/internal/app` directory (e.g., `/internal/app/myapp`) and the code shared by those apps in the `/internal/pkg` directory (e.g., `/internal/pkg/myprivlib`).
+You can optionally add a bit of extra structure to your internal packages to separate your shared and non-shared internal code. It's not required (especially for smaller projects), but it's nice to have visual clues showing the intended package use. Your actual application code can go in the `/internal/app` directory (e.g., `/internal/app/myapp`) and the code shared by those apps in the `/internal/pkg` directory (e.g., `/internal/pkg/myprivlib`).
 
 ### `/pkg`
 

diff --git a/cmd/README.md b/cmd/README.md
@@ -15,4 +15,5 @@ Examples:
 * https://github.com/prometheus/prometheus/tree/master/cmd
 * https://github.com/influxdata/influxdb/tree/master/cmd
 * https://github.com/kubernetes/kubernetes/tree/master/cmd
+* https://github.com/satellity/satellity/tree/master/cmd/satellity
 
diff --git a/internal/README.md b/internal/README.md
@@ -1,5 +1,14 @@
 # `/internal`
 
-Private application and library code. This is the code you don't want others importing in their applications or libraries.
+Private application and library code. This is the code you don't want others importing in their applications or libraries. Note that this layout pattern is enforced by the Go compiler itself. See the Go 1.4 [`release notes`](https://golang.org/doc/go1.4#internalpackages) for more details.
 
-You can optionally add a bit of extra structure to your internal packages to separate your shared and non-shared internal code. It's not required, but it's nice to have visual clues showing the intended package use. Your actual application code can go in the `/internal/app` directory (e.g., `/internal/app/myapp`) and the code shared by those apps in the `/internal/pkg` directory (e.g., `/internal/pkg/myprivlib`).
+You can optionally add a bit of extra structure to your internal packages to separate your shared and non-shared internal code. It's not required (especially for smaller projects), but it's nice to have visual clues showing the intended package use. Your actual application code can go in the `/internal/app` directory (e.g., `/internal/app/myapp`) and the code shared by those apps in the `/internal/pkg` directory (e.g., `/internal/pkg/myprivlib`).
+
+Examples:
+
+* https://github.com/hashicorp/terraform/tree/master/internal
+* https://github.com/influxdata/influxdb/tree/master/internal
+* https://github.com/perkeep/perkeep/tree/master/internal
+* https://github.com/jaegertracing/jaeger/tree/master/internal
+* https://github.com/moby/moby/tree/master/internal
+* https://github.com/satellity/satellity/tree/master/internal