@jaamd/jaad 0.0.0-stage → 1.0.0-rc.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Luca Pattocchio
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,59 @@
-# Temporary Holding Version
+<p align="center">
+  <a href="https://docs.jaamd.org/jaad">
+    <img src="./assets/readme-header.png" alt="JAAD — Just Another Astro Docs. Documentation, simplified." width="1200" />
+  </a>
+</p>
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+<p align="center">
+  An <a href="https://astro.build">Astro</a> integration that turns a folder of markdown into a documentation site.
+</p>
+
+<div align="center">
+
+[![main](https://github.com/jaamd/jaamd/actions/workflows/ci.yml/badge.svg)](https://github.com/jaamd/jaamd/actions/workflows/ci.yml)
+[![License](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/withastro/astro/blob/main/LICENSE)
+[![npm version](https://badge.fury.io/js/@jaamd%2Fjaad.svg)](https://badge.fury.io/js/@jaamd%2Fjaad)
+</div>
+
+```bash
+npm create @jaamd/jaad@latest my-docs
+```
+
+Or add it to a repository that already has a `docs/` folder:
+
+```bash
+npm create @jaamd/jaad@latest -- --here
+```
+
+By hand:
+
+```bash
+npm install @jaamd/jaad
+```
+
+```ts
+// jaad.config.ts
+import { defineJaadConfig } from '@jaamd/jaad'
+
+export default defineJaadConfig({
+    site: 'https://example.dev',
+    title: 'My Project',
+})
+```
+
+## Documentation
+
+The documentation ships with the package, in
+[`docs/`](https://github.com/jaamd/jaamd/tree/main/packages/jaad/docs): once
+installed, at `node_modules/@jaamd/jaad/docs/`. Point an agent's `AGENTS.md`
+there; projects made with `create-jaad` already do. It is also published at
+[docs.jaamd.org/jaad](https://docs.jaamd.org/jaad).
+
+## Contributing
+
+See [CONTRIBUTING.md](./CONTRIBUTING.md), including the guide for contributing
+new interface translations.
+
+## License
+
+jaad is released under the [MIT License](/LICENSE).