From 0bfa73e2bab0ac7fdcc66772977768847a3ebb99 Mon Sep 17 00:00:00 2001 From: anazibinurasheed Date: Wed, 6 Sep 2023 13:35:43 +0530 Subject: [PATCH] Updated the README.md file by adding a paragraph that provides further clarification on the purpose of the 'internal' directory. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 3396548..2766281 100644 --- a/README.md +++ b/README.md @@ -68,7 +68,7 @@ Private application and library code. This is the code you don't want others imp 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`). -You use internal directories to make packages private. If you put a package inside an internal directory, then other packages can’t import it unless they share a common ancestor. It’s the only directory named in Go’s documentation and has special compiler treatment. +You use internal directories to make packages private. If you put a package inside an internal directory, then other packages can’t import it unless they share a common ancestor. And it’s the only directory named in Go’s documentation and has special compiler treatment. ### `/pkg`