From bcd25e0d38a663933371e1417f6908d7eda52660 Mon Sep 17 00:00:00 2001 From: Alexandre Date: Sun, 12 Jul 2020 15:49:59 +0200 Subject: [PATCH] :pencil: Update some readme + App.tsx file to point to the right file --- README.md | 32 ++++++++------------------------ js/README.md | 7 ++----- ts/README.md | 7 ++----- ts/src/App.tsx | 2 +- 4 files changed, 13 insertions(+), 35 deletions(-) diff --git a/README.md b/README.md index 4a973cc..1c6d45d 100644 --- a/README.md +++ b/README.md @@ -3,29 +3,13 @@ ```bash # Javascript template $ npx degit amoutonbrady/vite-template-solid/js#main my-solid-project -# Typescript template -$ npx degit amoutonbrady/vite-template-solid/ts#main my-solid-project +$ cd my-solid-project +$ npm install # or pnpm install or yarn install ``` -## Available Scripts - -In the project directory, you can run: - -### `npm start` - -Runs the app in the development mode.
-Open [http://localhost:3000](http://localhost:3000) to view it in the browser. - -The page will reload if you make edits.
- -### `npm run build` - -Builds the app for production to the `dist` folder.
-It correctly bundles Solid in production mode and optimizes the build for the best performance. - -The build is minified and the filenames include the hashes.
-Your app is ready to be deployed! - -## Deployment - -You can deploy the `dist` folder to any static host provider (netlify, surge, now, etc.) +```bash +# Typescript template +$ npx degit amoutonbrady/vite-template-solid/ts#main my-solid-project +$ cd my-solid-project +$ npm install # or pnpm install or yarn install +``` diff --git a/js/README.md b/js/README.md index 4a973cc..03a2e3f 100644 --- a/js/README.md +++ b/js/README.md @@ -1,10 +1,7 @@ -## Install +## Usage ```bash -# Javascript template -$ npx degit amoutonbrady/vite-template-solid/js#main my-solid-project -# Typescript template -$ npx degit amoutonbrady/vite-template-solid/ts#main my-solid-project +$ npm install # or pnpm install or yarn install ``` ## Available Scripts diff --git a/ts/README.md b/ts/README.md index 4a973cc..03a2e3f 100644 --- a/ts/README.md +++ b/ts/README.md @@ -1,10 +1,7 @@ -## Install +## Usage ```bash -# Javascript template -$ npx degit amoutonbrady/vite-template-solid/js#main my-solid-project -# Typescript template -$ npx degit amoutonbrady/vite-template-solid/ts#main my-solid-project +$ npm install # or pnpm install or yarn install ``` ## Available Scripts diff --git a/ts/src/App.tsx b/ts/src/App.tsx index 1d726b6..04a7ef0 100644 --- a/ts/src/App.tsx +++ b/ts/src/App.tsx @@ -7,7 +7,7 @@ function App() {

- Edit src/App.js and save to reload. + Edit src/App.tsx and save to reload.