create-steedos-app 2.2.52-beta.3 → 2.2.52-beta.34

package/LICENSE.txt

@@ -6,9 +6,8 @@ To determine under which license you may use a file from the Steedos source code
 please resort to the header of that file.
 
 If the file has no header, the following rules apply
-1. project templates are licensed under MIT, see License.MIT.txt
-2. enterprise features are licensed under Steedos Enterprise Terms, see License.enterprise.txt
-3. source code that is neither (1) nor (2) is licensed under AGPL, see License.AGPL.txt
+1. enterprise features are licensed under Steedos Enterprise Terms, see License.enterprise.txt
+2. source code that is neither (1) is licensed under MIT, see https://opensource.org/licenses/MIT
 
 On request, licenses under different terms are available.
 

package/README.md

@@ -1,2 +1,51 @@
-## 功能说明
-- 此包是npx命令`create-steedos-app`，用于创建项目，如 `npx create-steedos-app my-app`
+# Create Steedos App
+
+The easiest way to get started with Next.js is by using `create-steedos-app`. This CLI tool enables you to quickly start building a new Next.js application, with everything set up for you. You can create a new app using the default Next.js template, or by using one of the [official Next.js examples](https://github.com/vercel/next.js/tree/canary/examples). To get started, use the following command:
+
+```bash
+npx create-steedos-app@latest
+# or
+yarn create next-app
+# or
+pnpm create next-app
+```
+
+Or, for a [TypeScript project](https://github.com/vercel/next.js/blob/canary/docs/basic-features/typescript.md):
+
+```bash
+npx create-steedos-app@latest --typescript
+# or
+yarn create next-app --typescript
+# or
+pnpm create next-app --typescript
+```
+
+To create a new app in a specific folder, you can send a name as an argument. For example, the following command will create a new Next.js app called `blog-app` in a folder with the same name:
+
+```bash
+npx create-steedos-app@latest blog-app
+# or
+yarn create next-app blog-app
+# or
+pnpm create next-app blog-app
+```
+
+## Options
+
+`create-steedos-app` comes with the following options:
+
+- **--ts, --typescript** - Initialize as a TypeScript project.
+- **-e, --example [name]|[github-url]** - An example to bootstrap the app with. You can use an example name from the [Next.js repo](https://github.com/vercel/next.js/tree/canary/examples) or a GitHub URL. The URL can use any branch and/or subdirectory.
+- **--example-path <path-to-example>** - In a rare case, your GitHub URL might contain a branch name with a slash (e.g. bug/fix-1) and the path to the example (e.g. foo/bar). In this case, you must specify the path to the example separately: `--example-path foo/bar`
+- **--use-npm** - Explicitly tell the CLI to bootstrap the app using npm. To bootstrap using yarn we recommend to run `yarn create next-app`
+- **--use-pnpm** - Explicitly tell the CLI to bootstrap the app using pnpm. To bootstrap using pnpm we recommend running `pnpm create next-app`
+
+## Why use Create Next App?
+
+`create-steedos-app` allows you to create a new Next.js app within seconds. It is officially maintained by the creators of Next.js, and includes a number of benefits:
+
+- **Interactive Experience**: Running `npx create-steedos-app` (with no arguments) launches an interactive experience that guides you through setting up a project.
+- **Zero Dependencies**: Initializing a project is as quick as one second. Create Next App has zero dependencies.
+- **Offline Support**: Create Next App will automatically detect if you're offline and bootstrap your project using your local package cache.
+- **Support for Examples**: Create Next App can bootstrap your application using an example from the Next.js examples collection (e.g. `npx create-steedos-app --example api-routes`).
+- **Tested**: The package is part of the Next.js monorepo and tested using the same integration test suite as Next.js itself, ensuring it works as expected with every release.