create-seedcord 0.1.0 → 0.1.2-next.0

package/README.md

@@ -1,13 +1,31 @@
-<p align="center">
+<div align="center">
   <picture>
     <source media="(prefers-color-scheme: dark)" srcset="https://cdn.seedcord.org/assets/wordmark-dark.webp" />
     <img src="https://cdn.seedcord.org/assets/wordmark-light.webp" alt="seedcord" width="440" />
   </picture>
-</p>
+</div>
 
-# create-seedcord
+<div align="center">
+  <h3>The whole Discord bot, wired and typed</h3>
+  <a href="https://seedcord.org">Website</a> ·
+  <a href="https://guide.seedcord.org">Guide</a> ·
+  <a href="https://docs.seedcord.org">Reference</a> ·
+  <a href="https://discord.gg/DzFxY58WXf">Discord</a>
+</div>
 
-Scaffold a new seedcord bot project.
+<br />
+
+<div align="center">
+
+[![npm](https://img.shields.io/npm/v/create-seedcord?style=flat-square&logo=npm&logoColor=c8341f&label=&labelColor=1f1f1f&color=c8341f)](https://www.npmjs.com/package/create-seedcord) [![node](https://img.shields.io/node/v/create-seedcord?style=flat-square&label=node&labelColor=1f1f1f&color=4d7d33)](https://nodejs.org) [![license](https://img.shields.io/npm/l/create-seedcord?style=flat-square&label=license&labelColor=1f1f1f&color=f8f6e8)](LICENSE)
+
+</div>
+
+## About
+
+`create-seedcord` scaffolds a new seedcord bot project.
+
+Until v1.0.0, minor versions can break.
 
 ## Usage
 
@@ -19,6 +37,8 @@ yarn create seedcord my-bot
 
 It asks where the project goes, how Discord reaches your bot, what the bot should react to, your bot token, and an accent color. Then it writes the project, installs, formats, generates your command types, and makes the first commit.
 
+On Windows, run it from Windows Terminal. The prompts fall back to ASCII in `cmd.exe` making the boxes draw as `T`, `|`, and `o`.
+
 ## Flags
 
 Every question has a flag. Pass them all to skip all questions. `--help` prints the list.
@@ -36,13 +56,6 @@ With no terminal to ask on, it reads the flags alone. It names the flag that wou
 
 ## What you get
 
-You get a TypeScript project with one slash command, its handler, a sample event handler (if you picked `gateway`), `seedcord.config.ts`, eslint, prettier, and a `.env` listing every key the framework reads.
+A TypeScript project holding one slash command, its handler, a sample event handler (if you picked `gateway`), `seedcord.config.ts`, eslint, prettier, and a `.env` listing every key the framework reads.
 
 `pnpm dev` starts it with hot reload. On the http transport it also opens a cloudflared tunnel and sets it up, and Discord posts interactions to that URL.
-
-## Docs
-
-- Guide: <https://guide.seedcord.org>
-- API reference: <https://docs.seedcord.org>
-
-Part of the [seedcord](https://github.com/seedcord/seedcord) framework. Until a major v1.0.0 release, expect breaking changes in minor versions.