From 3e51dcc19e8076de4d964eed937c4ff1a8fb717a Mon Sep 17 00:00:00 2001
From: Katsuhiro Ueno <uenobk@gmail.com>
Date: Sat, 9 Dec 2023 15:18:05 +0900
Subject: [PATCH] add README.md to renderer packages

---
 README.md                        | 24 ++++++++++++++++++++----
 packages/render-preact/README.md |  9 +++++++++
 packages/render-react/README.md  |  9 +++++++++
 packages/render-solid/README.md  |  9 +++++++++
 packages/render-svelte/README.md |  9 +++++++++
 packages/render-vue/README.md    |  9 +++++++++
 6 files changed, 65 insertions(+), 4 deletions(-)
 create mode 100644 packages/render-preact/README.md
 create mode 100644 packages/render-react/README.md
 create mode 100644 packages/render-solid/README.md
 create mode 100644 packages/render-svelte/README.md
 create mode 100644 packages/render-vue/README.md

diff --git a/README.md b/README.md
index f30aafa..26dff22 100644
--- a/README.md
+++ b/README.md
@@ -12,11 +12,27 @@ framework, so that it does not hide anything in JS and Vite from the
 users.
 With Minissg, any decision and convention for static site generation
 are up to you; for example, you can write your static webpages with
-any of your favorite technologies including [React], [Preact],
-[Solid], [Svelte], [Vue], [Markdown], [MDX], and even any combination
-of them, in exchange of a little effort to write some JS code and some
-configurations in `vite.config.js`.
+any combination of your favorite JS technologies in exchange of a
+little effort to write some JS code and some configurations in
+`vite.config.js`.
 
 See [packages/vite-plugin-minissg/README.md] for details.
 
+## Packages
+
+This is a monorepo containing Minissg and its related packages.
+
+* [vite-plugin-minissg]
+* [@minissg/render-preact]
+* [@minissg/render-react]
+* [@minissg/render-solid]
+* [@minissg/render-svelte]
+* [@minissg/render-vue]
+
 [packages/vite-plugin-minissg/README.md]: packages/vite-plugin-minissg/README.md
+[vite-plugin-minissg]: packages/vite-plugin-minissg
+[@minissg/render-preact]: packages/render-preact
+[@minissg/render-react]: packages/render-react
+[@minissg/render-solid]: packages/render-solid
+[@minissg/render-svelte]: packages/render-svelte
+[@minissg/render-vue]: packages/render-vue
diff --git a/packages/render-preact/README.md b/packages/render-preact/README.md
new file mode 100644
index 0000000..6f857fb
--- /dev/null
+++ b/packages/render-preact/README.md
@@ -0,0 +1,9 @@
+# @minissg/render-preact
+
+A renderer plugin for combining [Minissg] with [Preact].
+
+See [Minissg's README] for details.
+
+[Minissg]: https://github.com/uenoB/vite-plugin-minissg
+[Preact]: https://preactjs.com
+[Minissg's README]: https://github.com/uenoB/vite-plugin-minissg/blob/main/packages/vite-plugin-minissg/README.md
diff --git a/packages/render-react/README.md b/packages/render-react/README.md
new file mode 100644
index 0000000..080a481
--- /dev/null
+++ b/packages/render-react/README.md
@@ -0,0 +1,9 @@
+# @minissg/render-react
+
+A renderer plugin for combining [Minissg] with [React].
+
+See [Minissg's README] for details.
+
+[Minissg]: https://github.com/uenoB/vite-plugin-minissg
+[React]: https://react.dev
+[Minissg's README]: https://github.com/uenoB/vite-plugin-minissg/blob/main/packages/vite-plugin-minissg/README.md
diff --git a/packages/render-solid/README.md b/packages/render-solid/README.md
new file mode 100644
index 0000000..17b8112
--- /dev/null
+++ b/packages/render-solid/README.md
@@ -0,0 +1,9 @@
+# @minissg/render-solid
+
+A renderer plugin for combining [Minissg] with [Solid.js].
+
+See [Minissg's README] for details.
+
+[Minissg]: https://github.com/uenoB/vite-plugin-minissg
+[Solid.js]: https://www.solidjs.com
+[Minissg's README]: https://github.com/uenoB/vite-plugin-minissg/blob/main/packages/vite-plugin-minissg/README.md
diff --git a/packages/render-svelte/README.md b/packages/render-svelte/README.md
new file mode 100644
index 0000000..4e3b0a7
--- /dev/null
+++ b/packages/render-svelte/README.md
@@ -0,0 +1,9 @@
+# @minissg/render-svelte
+
+A renderer plugin for combining [Minissg] with [Svelte].
+
+See [Minissg's README] for details.
+
+[Minissg]: https://github.com/uenoB/vite-plugin-minissg
+[Svelte]: https://svelte.dev
+[Minissg's README]: https://github.com/uenoB/vite-plugin-minissg/blob/main/packages/vite-plugin-minissg/README.md
diff --git a/packages/render-vue/README.md b/packages/render-vue/README.md
new file mode 100644
index 0000000..65b933c
--- /dev/null
+++ b/packages/render-vue/README.md
@@ -0,0 +1,9 @@
+# @minissg/render-vue
+
+A renderer plugin for combining [Minissg] with [Vue].
+
+See [Minissg's README] for details.
+
+[Minissg]: https://github.com/uenoB/vite-plugin-minissg
+[Vue]: https://vuejs.org
+[Minissg's README]: https://github.com/uenoB/vite-plugin-minissg/blob/main/packages/vite-plugin-minissg/README.md