docs: add README to all packages. fixes #188

Author: rakannimer

core/docz-core/README.md

@@ -0,0 +1,7 @@
+## docz-core
+
+All CLI commands are built here and imported from `docz` package using `./bin` script.
+
+Code in this package does not run on the browser, it runs on node.
+
+Unless you're looking to contribute to docz, you probably don't care about this package and are looking for [the docz package documentation](https://github.com/doczjs/docz).

core/docz-rollup/README.md

@@ -0,0 +1,5 @@
+## docz-rollup
+
+This is an internal docz package containing a [rollup](https://github.com/rollup/rollup) config used by docz to build its packages.
+
+Unless you're looking to contribute to docz, you probably don't care about this package and are looking for [the docz package documentation](https://github.com/doczjs/docz).

core/docz-utils/README.md

@@ -0,0 +1,5 @@
+## docz-utils
+
+This is an internal docz package containing utility functions used by multiple docz packages.
+
+Unless you're looking to contribute to docz, you probably don't care about this package and are looking for [the docz package documentation](https://github.com/doczjs/docz).

core/rehype-docz/README.md

@@ -0,0 +1,5 @@
+## rehype-docz
+
+This is an internal docz package containing the [rehype](https://github.com/rehypejs/rehype) plugin used by docz.
+
+Unless you're looking to contribute to docz, you probably don't care about this package and are looking for [the docz package documentation](https://github.com/doczjs/docz).

core/remark-docz/README.md

@@ -0,0 +1,5 @@
+## remark-docz
+
+This is an internal docz package containing the [remark](https://github.com/remarkjs/remark) plugin used by docz.
+
+Unless you're looking to contribute to docz, you probably don't care about this package and are looking for [the docz package documentation](https://github.com/doczjs/docz).

other-packages/babel-plugin-export-metadata/README.md

@@ -0,0 +1,5 @@
+## babel-plugin-export-metadata
+
+This is an internal docz babel plugin used to add file metadata for function declarations.
+
+Unless you're looking to contribute to docz, you probably don't care about this package and are looking for [the docz package documentation](https://github.com/doczjs/docz).

other-packages/eslint-config-docz-js/README.md

@@ -0,0 +1,5 @@
+## eslint-config-docz-js
+
+This is an internal docz eslint config used in docz JS modules.
+
+Unless you're looking to contribute to docz, you probably don't care about this package and are looking for [the docz package documentation](https://github.com/doczjs/docz).

other-packages/eslint-config-docz-ts/README.md

@@ -0,0 +1,5 @@
+## eslint-config-docz-ts
+
+This is an internal docz eslint config used in docz TS modules.
+
+Unless you're looking to contribute to docz, you probably don't care about this package and are looking for [the docz package documentation](https://github.com/doczjs/docz).

other-packages/load-cfg/README.md

@@ -0,0 +1,5 @@
+## load-cfg
+
+This is an internal docz package used to load the docz config from a project into memory.
+
+Unless you're looking to contribute to docz, you probably don't care about this package and are looking for [the docz package documentation](https://github.com/doczjs/docz).

other-packages/react-docgen-actual-name-handler/README.md

@@ -0,0 +1,5 @@
+## react-docgen-actual-name-handler
+
+This is an internal docz [react-docgen](https://github.com/reactjs/react-docgen) [handler](https://github.com/reactjs/react-docgen#handlers) used to set `actualName` on React components.
+
+Unless you're looking to contribute to docz, you probably don't care about this package and are looking for [the docz package documentation](https://github.com/doczjs/docz).