Update docs

Author: akd-io

packages/create-next-stack/README.md

@@ -1,50 +1,36 @@
-<img width="100%" src="assets/banner.png" alt="A screenshot of the Create Next Stack website">
+# Create Next Stack
 
-<p align="center">
-  <a aria-label="NPM version" href="https://www.npmjs.com/package/create-next-stack">
-    <img alt="" src="https://img.shields.io/npm/v/create-next-stack?style=flat-square">
-  </a>
-  <a aria-label="Build status" href="https://github.com/akd-io/create-next-stack/actions/workflows/main.yml?query=branch%3Adevelop">
-    <img alt="" src="https://img.shields.io/github/actions/workflow/status/akd-io/create-next-stack/main.yml?branch=develop&style=flat-square">
-  </a>
+<p>
   <a aria-label="Last commit" href="https://github.com/akd-io/create-next-stack/commits/develop">
     <img alt="" src="https://img.shields.io/github/last-commit/akd-io/create-next-stack/develop?style=flat-square">
   </a>
-  <a aria-label="License" href="https://github.com/akd-io/create-next-stack/blob/develop/LICENSE">
+  <a aria-label="License" href="https://github.com/akd-io/create-next-stack/blob/develop/packages/create-next-stack/LICENSE">
     <img alt="" src="https://img.shields.io/npm/l/create-next-stack?color=44cc11&style=flat-square">
   </a>
-  <a aria-label="Create Next Stack Website GitHub Repository" href="https://github.com/akd-io/create-next-stack-website">
-    <img alt="" src="https://img.shields.io/badge/Website-gray?style=flat-square&logo=github">
-  </a>
-  <a aria-label="GitHub Repo stars" href="https://github.com/akd-io/create-next-stack">
-    <img alt="" src="https://img.shields.io/github/stars/akd-io/create-next-stack?style=social">
+  <a aria-label="NPM version" href="https://www.npmjs.com/package/create-next-stack">
+    <img alt="" src="https://img.shields.io/npm/v/create-next-stack?style=flat-square">
   </a>
   <a aria-label="Community Discord" href="https://discord.gg/7Ns5WwGjjZ">
     <img alt="" src="https://img.shields.io/badge/Discord-gray?style=flat-square&logo=discord">
   </a>
   <a aria-label="Twitter profile of the creator of Create Next Stack" href="https://twitter.com/akd_io">
     <img alt="" src="https://img.shields.io/badge/Twitter-gray?style=flat-square&logo=twitter">
   </a>
+  <a aria-label="GitHub Repo stars" href="https://github.com/akd-io/create-next-stack">
+    <img alt="" src="https://img.shields.io/github/stars/akd-io/create-next-stack?style=social">
+  </a>
 </p>
 
 [Create Next Stack](https://www.create-next-stack.com/) is a website and CLI tool used to easily set up the boilerplate of new [Next.js](https://github.com/vercel/next.js) apps.
 
 Where [Create Next App](https://github.com/vercel/next.js/tree/canary/packages/create-next-app) lets you choose a single template only, Create Next Stack lets you pick and choose an array of technologies often used alongside Next.js, and free you of the pain of making them work together.
 
-This repository covers the CLI tool, while [create-next-stack-website](https://github.com/akd-io/create-next-stack-website) covers the site.
-
-To get started, go to [create-next-stack.com](https://www.create-next-stack.com). Here you'll be able to choose the technologies you want to use and get the corresponding CLI command.
-
-<p align="center">
-  <img width="600" alt="Screenshot of Create Next Stack running in a terminal" src="assets/screenshot.png">
-</p>
+To get started, go to [create-next-stack.com](https://www.create-next-stack.com).
 
 ## Supported technologies
 
 The table below provides an overview of the technologies currently supported by Create Next Stack.
 
-### Technologies table
-
 | Name                                                      | Links                                                                                                                                                                |
 | --------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | [Next.js](https://nextjs.org/) (Mandatory)                | [Docs](https://nextjs.org/docs) - [Learn Next.js](https://nextjs.org/learn) - [GitHub repo](https://github.com/vercel/next.js)                                       |
@@ -76,26 +62,27 @@ Below you see an overview of Create Next Stack's usage, including detailed infor
 
 ```
 USAGE
-  $ create-next-stack [APPNAME]
+  $ create-next-stack [APP_NAME] [FLAGS]
 
 ARGUMENTS
-  APPNAME  The name of your app, optionally including a path prefix. Eg.: "my-app" or "path/to/my-app"
-
-OPTIONS
-  -h, --help                         Shows the CLI help information.
-  -v, --version                      Shows the CLI version information.
-  --chakra                           Adds Chakra UI. (Component library) (Requires Emotion and Framer Motion)
-  --debug                            Show verbose error messages for debugging purposes.
-  --formatting-pre-commit-hook       Adds a formatting pre-commit hook. (Requires Prettier)
-  --formik                           Adds Formik. (Form library)
-  --framer-motion                    Adds Framer Motion. (Animation library)
-  --github-actions                   Adds a GitHub Actions continuous integration workflow.
-  --material-ui                      Adds Material UI. (Component library)
-  --package-manager=(pnpm|yarn|npm)  Sets the preferred package manager. (Required)
-  --prettier                         Adds Prettier. (Code formatting)
-  --react-hook-form                  Adds React Hook Form. (Form library)
-  --react-icons                      Adds React Icons. (Icon library)
-  --styling=<styling-method>         Sets the preferred styling method. (Required) <styling-method> = emotion|styled-components|tailwind-css|css-modules|css-modules-with-sass
+  APP_NAME  The name of your app, optionally including a path prefix. Eg.: "my-app" or "path/to/my-app"
+
+FLAGS
+  -h, --help                    Shows the CLI help information.
+  -v, --version                 Shows the CLI version information.
+  --chakra                      Adds Chakra UI. (Component library) (Requires Emotion and Framer Motion)
+  --debug                       Show verbose error messages for debugging purposes.
+  --formatting-pre-commit-hook  Adds a formatting pre-commit hook. (Requires Prettier)
+  --formik                      Adds Formik. (Form library)
+  --framer-motion               Adds Framer Motion. (Animation library)
+  --github-actions              Adds a GitHub Actions continuous integration workflow.
+  --material-ui                 Adds Material UI. (Component library)
+  --package-manager=<option>    Sets the preferred package manager. (Required)
+                                <options: pnpm|yarn|npm>
+  --prettier                    Adds Prettier. (Code formatting)
+  --react-hook-form             Adds React Hook Form. (Form library)
+  --react-icons                 Adds React Icons. (Icon library)
+  --styling=<styling-method>    Sets the preferred styling method. (Required) <styling-method> = emotion|styled-components|tailwind-css|css-modules|css-modules-with-sass
 ```
 
 ## Contributing

packages/create-next-stack/assets/banner.png

@@ -58,7 +58,7 @@
     "test:cna": "pnpm build && ts-node src/tests/e2e/test-live-cna.ts",
     "test:cns": "pnpm build && ts-node src/tests/e2e/test-live-cns.ts",
     "print:help": "pnpm build && ./bin/dev --help",
-    "print:version": "pnpm build && ./bin/dev --help",
+    "print:version": "pnpm build && ./bin/dev --version",
     "lint": "eslint --ext=.ts --config=.eslintrc --ignore-path=../../.prettierignore ."
   },
   "dependencies": {

packages/create-next-stack/assets/convenience-icon.png

@@ -15,13 +15,10 @@ import { logInfo } from "../logging"
 import { performSetupSteps } from "../setup/setup"
 
 export default class CreateNextStack extends Command {
-  static description =
-    "Create Next Stack is a website and CLI tool used to easily set up the boilerplate of new Next.js apps."
-
   static usage = "[APP_NAME] [FLAGS]" // Without "create-next-stack" as OCLIF adds this, even though this is a single command CLI.
 
   static args = {
-    appName: Args.string({
+    app_name: Args.string({
       description: `The name of your app, optionally including a path prefix. Eg.: "my-app" or "path/to/my-app"`,
       required: false,
     }),

packages/create-next-stack/assets/required-icon.png

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 Anders Kjær Damgaard
+Copyright (c) Anders Kjær Damgaard
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

packages/create-next-stack/assets/screenshot.png

@@ -1,43 +1,12 @@
-<img width="100%" src="assets/banner.png" alt="A screenshot of the Create Next Stack website">
-
-<p align="center">
-  <a aria-label="Build status" href="https://github.com/akd-io/create-next-stack-website/actions/workflows/main.yml?query=branch%3Adevelop">
-    <img alt="" src="https://img.shields.io/github/workflow/status/akd-io/create-next-stack-website/CI/develop?style=flat-square">
-  </a>
-  <a aria-label="Last commit" href="https://github.com/akd-io/create-next-stack-website/commits/develop">
-    <img alt="" src="https://img.shields.io/github/last-commit/akd-io/create-next-stack-website/develop?style=flat-square">
-  </a>
-  <a aria-label="License" href="https://github.com/akd-io/create-next-stack-website/blob/develop/LICENSE">
-    <img alt="" src="https://img.shields.io/npm/l/create-next-stack-website?color=44cc11&style=flat-square">
-  </a>
-  <a aria-label="Create Next Stack CLI GitHub Repository" href="https://github.com/akd-io/create-next-stack">
-    <img alt="" src="https://img.shields.io/badge/CLI-gray?style=flat-square&logo=github">
-  </a>
-  <a aria-label="Community Discord" href="https://discord.gg/7Ns5WwGjjZ">
-    <img alt="" src="https://img.shields.io/badge/Discord-gray?style=flat-square&logo=discord">
-  </a>
-  <a aria-label="Twitter profile of the creator of Create Next Stack" href="https://twitter.com/akd_io">
-    <img alt="" src="https://img.shields.io/badge/Twitter-gray?style=flat-square&logo=twitter">
-  </a>
-</p>
-
 # Create Next Stack Website
 
-Welcome to the repository of the [create-next-stack.com](https://www.create-next-stack.com/) website.
+Welcome to the `create-next-stack-website` package. This package contains the code for [www.create-next-stack.com](https://www.create-next-stack.com/). If you are looking for the CLI, you can find it in the [here](/packages/create-next-stack/README.md).
 
-This project acts as the UI for the create-next-stack CLI. All issues not specific to the website should be posted to the [create-next-stack repository](https://github.com/akd-io/create-next-stack) instead.
+This website acts as the landing page, UI, and docs, for Create Next Stack.
 
 ## Contributing
 
-If you've found a bug or has an idea for an improvement, please [create a new issue](https://github.com/akd-io/create-next-stack-website/issues/new) or fork the project and submit a pull request.
-
-### Getting started
-
-To get started, run:
-
-```bash
-yarn dev
-```
+If you've found a bug or has an idea for an improvement, please [open an issue](https://github.com/akd-io/create-next-stack-website/issues/new) or consider [contributing](../CONTRIBUTING.md).
 
 ## Scripts