Add README files to be displayed on npm

axelrindle · axelrindle · commit c7a8a7466209 · 2023-01-14T16:44:11.000+01:00
diff --git a/packages/api/README.md b/packages/api/README.md
@@ -0,0 +1,5 @@
+# @version-checker/api
+
+> The common API used by all version-checker modules.
+
+This is an utility package used by all `@version-checker`. It provides the general API specification.
diff --git a/packages/cli/README.md b/packages/cli/README.md
@@ -0,0 +1,7 @@
+# @version-checker/cli
+
+> CLI version of version-checker
+
+The CLI may come in handy in places where `@version-checker` can't be installed as a npm module.
+
+Read more [in the documentation](https://axelrindle.github.io/github-version-checker/docs/next/cli/).
diff --git a/packages/core/README.md b/packages/core/README.md
@@ -0,0 +1,5 @@
+# @version-checker/core
+
+> The heart of the `@version-checker` project.
+
+All you need to know regarding usage can be found [in the documentation](https://axelrindle.github.io/github-version-checker/docs/next/usage/).
