Browse code

Add README to pkg

Solomon Hykes authored on 2013/12/24 08:12:19
Showing 1 changed files
1 1
new file mode 100644
... ...
@@ -0,0 +1,11 @@
0
+pkg/ is a collection of utility packages used by the Docker project without being specific to its internals.
1
+
2
+Utility packages are kept separate from the docker core codebase to keep it as small and concise as possible.
3
+If some utilities grow larger and their APIs stabilize, they may be moved to their own repository under the
4
+Docker organization, to facilitate re-use by other projects. However that is not the priority.
5
+
6
+The directory `pkg` is named after the same directory in the camlistore project. Since Brad is a core
7
+Go maintainer, we thought it made sense to copy his methods for organizing Go code :) Thanks Brad!
8
+
9
+Because utility packages are small and neatly separated from the rest of the codebase, they are a good
10
+place to start for aspiring maintainers and contributors. Get in touch if you want to help maintain them!