add basic readme

primer · Nov 30, 2023 · 6dd024f · 6dd024f
1 parent 81f33b3
commit 6dd024f
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,19 @@
+<div align="center">
+  <img width="400px" src="https://github.com/primer/nextocat/assets/13340707/f554b768-591b-42b0-93ad-3e76a975dc5a">
+</div>
+
+<h1 align="center">Primer Nextocat</h1>
+
+<p align="center"><strong>A Next.js theme for building Primer documentation sites</strong>
+</p>
+
+<p align="center">🚧 Under active development 🚧
+</p>
+
+---
+
+### Useful links
+
+🔗 [See the working demo](https://primer.github.io/nextocat/)
+
+📝 [Read the ADR for this project](https://github.com/github/primer/blob/rezrah/prefer-nextjs-over-gatsby/adrs/2023-11-30-nextjs-documentation-framework.md)
diff --git a/package-lock.json b/package-lock.json