update starter template info and readme's

solidjs · Jun 27, 2021 · 742bc27 · 742bc27
1 parent 64e508c
commit 742bc27
Show file tree

Hide file tree

Showing 4 changed files with 41 additions and 29 deletions.
diff --git a/README.md b/README.md
@@ -27,7 +27,8 @@ Solid is a declarative JavaScript library for creating user interfaces. It does
   - Shadow DOM Portals
 - Transparent debugging: a `<div>` is just a div.
 
-[Top 5 Things You Should Know about Solid](https://dev.to/ryansolid/introducing-the-solidjs-ui-library-4mck)
+### Learn more on the [Solid Website](https//solidjs.com) and come chat with us on our [Discord](https://discord.com/invite/solidjs)
+
 
 ## The Gist
 
@@ -68,20 +69,26 @@ Want to see what code Solid generates:
 
 ## Quick Start
 
-> _`npm init solid <project-type> <project-name>` is available with npm 6+._
-
-You can get started with a simple app with the CLI with by running:
+You can get started with a simple app by running the following in your terminal:
 
 ```sh
-> npm init solid app my-app
+> npx degit solidjs/templates/js my-app
+> cd my-app
+> npm i # or yarn or pnpm
+> npm run dev # or yarn or pnpm
 ```
 
-Or for a TypeScript starter:
+Or for TypeScript:
 
 ```sh
-> npm init solid app-ts my-app
+> npx degit solidjs/templates/ts my-app
+> cd my-app
+> npm i # or yarn or pnpm
+> npm run dev # or yarn or pnpm
 ```
 
+This will create a minimal client-rendered application powered by [Vite](https://vitejs.dev/).
+
 Or you can install the dependencies in your own project. To use Solid with JSX (recommended) run:
 
 ```sh
@@ -105,8 +112,6 @@ For TypeScript remember to set your TSConfig to handle Solid's JSX by:
 
 ## Documentation
 
-> This is the documentation for the 1.0.0 RC. THese are significantly slimmed down from what was here previously as we are moving things to the new Docs site. If you wish to see the older docs in the mean time [look here](https://github.com/solidjs/solid/tree/0.x/#documentation).
-
 - [API](https://github.com/solidjs/solid/blob/main/documentation/api.md)
 - [FAQ](https://github.com/solidjs/solid/blob/main/documentation/faq.md)
 - [Comparison with other Libraries](https://github.com/solidjs/solid/blob/main/documentation/comparison.md)

diff --git a/documentation/guides/getting-started.md b/documentation/guides/getting-started.md
@@ -4,20 +4,22 @@
 
 By far the easiest way to get started with Solid is to try it online. Our REPL at https://playground.solidjs.com is the perfect way to try out ideas. As is https://codesandbox.io/ where you can modify any of our [examples](../resources/examples.md).
 
-Alternatively, you can use our CLI to bootstrap client-side a project (based on [Create React App](https://github.com/facebook/create-react-app)).
-
-> _`npm init solid <project-type> <project-name>` is available with npm 6+._
-
-You can get started with a simple CLI app by running:
+Alternatively, you can use our simple [Vite](https://vitejs.dev/) templates by runnings these commands in your terminal:
 
 ```sh
-> npm init solid app my-app
+> npx degit solidjs/templates/js my-app
+> cd my-app
+> npm i # or yarn or pnpm
+> npm run dev # or yarn or pnpm
 ```
 
-Or for a TypeScript starter:
+Or for TypeScript:
 
 ```sh
-> npm init solid app-ts my-app
+> npx degit solidjs/templates/ts my-app
+> cd my-app
+> npm i # or yarn or pnpm
+> npm run dev # or yarn or pnpm
 ```
 
 ## Learn Solid

diff --git a/documentation/resources/projects.md b/documentation/resources/projects.md
@@ -33,20 +33,21 @@
 - [solidjs-treeview-component](https://github.com/milahu/solidjs-treeview-component) Interactive tree of nodes, expand/collapse, fetch child nodes on demand
 
 ## Starters
+- [Solid Templates](https://github.com/solidjs/templates) - Official Solid Templates powered by [Vite](https://vitejs.dev/)
+- [Create Solid](https://github.com/solidjs/create-solid) Solid's port of Create React App.
 - [Solid TypeScript Rollup](https://github.com/high1/solid-typescript-rollup) - Rollup
 - [Solid Rollup Boilerplate](https://github.com/MrFoxPro/solid-rollup-boilerplate) - Rollup
 - [Solid TypeScript Starter](https://github.com/high1/solid-typescript-starter) - Webpack
 - [Solid TS Webpack](https://github.com/ryansolid/solid-ts-webpack) - Webpack
 - [Solid Parcel Starter](https://gitlab.com/enom/solid-parcel-starter) - Parcel
 - [Parcel 2 Solid TS Starter](https://github.com/amoutonbrady/parcel2-solid-ts-starter) - Parcel
 - [Solid Snowpack Starter](https://github.com/amoutonbrady/solid-snowpack-starter) - Snowpack
-- [Vite Template Solid](https://github.com/amoutonbrady/vite-template-solid) - Vite
+
 
 ## Tooling
 - [Solid Refresh](https://github.com/solidjs/solid-refresh) Universal plugin for HMR
 - [Solid Jest](https://github.com/solidjs/solid-jest) Presets to test Solid for Browser or Node
 - [Solid Testing Library](https://github.com/solidjs/solid-testing-library) Solid's Testing Library
-- [Create Solid](https://github.com/solidjs/create-solid) Solid's port of Create React App.
 - [Vite Plugin Solid](https://github.com/amoutonbrady/vite-plugin-solid) Solid plugin for Vite.
 - [Solid Playground](https://github.com/solidjs/solid-playground) A playground for Solid.
 - [Solid Debug](https://github.com/amoutonbrady/solid-debug) Simple visual debugger for Solid.

diff --git a/packages/solid/README.md b/packages/solid/README.md
@@ -27,7 +27,8 @@ Solid is a declarative JavaScript library for creating user interfaces. It does
   - Shadow DOM Portals
 - Transparent debugging: a `<div>` is just a div.
 
-[Top 5 Things You Should Know about Solid](https://dev.to/ryansolid/introducing-the-solidjs-ui-library-4mck)
+### Learn more on the [Solid Website](https//solidjs.com) and come chat with us on our [Discord](https://discord.com/invite/solidjs)
+
 
 ## The Gist
 
@@ -68,20 +69,26 @@ Want to see what code Solid generates:
 
 ## Quick Start
 
-> _`npm init solid <project-type> <project-name>` is available with npm 6+._
-
-You can get started with a simple app with the CLI with by running:
+You can get started with a simple app by running the following in your terminal:
 
 ```sh
-> npm init solid app my-app
+> npx degit solidjs/templates/js my-app
+> cd my-app
+> npm i # or yarn or pnpm
+> npm run dev # or yarn or pnpm
 ```
 
-Or for a TypeScript starter:
+Or for TypeScript:
 
 ```sh
-> npm init solid app-ts my-app
+> npx degit solidjs/templates/ts my-app
+> cd my-app
+> npm i # or yarn or pnpm
+> npm run dev # or yarn or pnpm
 ```
 
+This will create a minimal client-rendered application powered by [Vite](https://vitejs.dev/).
+
 Or you can install the dependencies in your own project. To use Solid with JSX (recommended) run:
 
 ```sh
@@ -105,8 +112,6 @@ For TypeScript remember to set your TSConfig to handle Solid's JSX by:
 
 ## Documentation
 
-> This is the documentation for the 1.0.0 RC. THese are significantly slimmed down from what was here previously as we are moving things to the new Docs site. If you wish to see the older docs in the mean time [look here](https://github.com/solidjs/solid/tree/0.x/#documentation).
-
 - [API](https://github.com/solidjs/solid/blob/main/documentation/api.md)
 - [FAQ](https://github.com/solidjs/solid/blob/main/documentation/faq.md)
 - [Comparison with other Libraries](https://github.com/solidjs/solid/blob/main/documentation/comparison.md)
@@ -122,7 +127,6 @@ For TypeScript remember to set your TSConfig to handle Solid's JSX by:
 - [Examples](https://github.com/solidjs/solid/blob/main/documentation/resources/examples.md)
 - [Articles](https://github.com/solidjs/solid/blob/main/documentation/resources/articles.md)
 - [Projects](https://github.com/solidjs/solid/blob/main/documentation/resources/projects.md)
-
 ## Browser Support
 
 The last 2 versions of modern evergreen browsers and Node LTS.