From 749999669126b89ed6140d386cb6714ad9eeb168 Mon Sep 17 00:00:00 2001 From: Simon Holthausen Date: Mon, 20 Feb 2023 10:20:18 +0100 Subject: [PATCH 1/3] chore: enhance library skeleton readme with some library instructions --- .changeset/curvy-lobsters-hug.md | 5 ++ .../shared/+skeletonlib/README.md | 56 +++++++++++++++++++ 2 files changed, 61 insertions(+) create mode 100644 .changeset/curvy-lobsters-hug.md create mode 100644 packages/create-svelte/shared/+skeletonlib/README.md diff --git a/.changeset/curvy-lobsters-hug.md b/.changeset/curvy-lobsters-hug.md new file mode 100644 index 000000000000..aef41791df86 --- /dev/null +++ b/.changeset/curvy-lobsters-hug.md @@ -0,0 +1,5 @@ +--- +'create-svelte': patch +--- + +chore: enhance library skeleton readme with some library instructions diff --git a/packages/create-svelte/shared/+skeletonlib/README.md b/packages/create-svelte/shared/+skeletonlib/README.md new file mode 100644 index 000000000000..f8f57238350c --- /dev/null +++ b/packages/create-svelte/shared/+skeletonlib/README.md @@ -0,0 +1,56 @@ +# create-svelte + +Everything you need to build a Svelte project, powered by [`create-svelte`](https://github.com/sveltejs/kit/tree/master/packages/create-svelte). + +## Creating a project + +If you're seeing this, you've probably already done this step. Congrats! + +```bash +# create a new project in the current directory +npm create svelte@latest + +# create a new project in my-app +npm create svelte@latest my-app +``` + +## Developing + +Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server: + +```bash +npm run dev + +# or start the server and open the app in a new browser tab +npm run dev -- --open +``` + +Everything inside `src/lib` is part of your library, everything inside `src/routes` can be used as a showcase or preview app. + +## Building + +To build your library: + +```bash +npm run package +``` + +To create a production version of your showcase app: + +```bash +npm run build +``` + +You can preview the production build with `npm run preview`. + +> To deploy your app, you may need to install an [adapter](https://kit.svelte.dev/docs/adapters) for your target environment. + +## Publishing + +Go into the `package.json` and give your package the desired name through the `"name"` option. Also consider adding a `"license"` field and point it to a `license.md` file which you can create from a template (one popular option is the [MIT license](https://opensource.org/license/mit/)). + +To publish your library to [npm](https://www.npmjs.com): + +```bash +npm publish +``` From ad9be14aa28b691ec5cf9b3518178ab679c8af3f Mon Sep 17 00:00:00 2001 From: Simon Holthausen Date: Mon, 20 Feb 2023 10:21:57 +0100 Subject: [PATCH 2/3] tweak --- packages/create-svelte/shared/+skeletonlib/README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/packages/create-svelte/shared/+skeletonlib/README.md b/packages/create-svelte/shared/+skeletonlib/README.md index f8f57238350c..c5a00d13e217 100644 --- a/packages/create-svelte/shared/+skeletonlib/README.md +++ b/packages/create-svelte/shared/+skeletonlib/README.md @@ -1,6 +1,8 @@ # create-svelte -Everything you need to build a Svelte project, powered by [`create-svelte`](https://github.com/sveltejs/kit/tree/master/packages/create-svelte). +Everything you need to build a Svelte library, powered by [`create-svelte`](https://github.com/sveltejs/kit/tree/master/packages/create-svelte). + +Read more about creating a library [in the docs](https://kit.svelte.dev/docs/packaging). ## Creating a project From 2797ebec007a5fc94d818c40a6b4533fc8e7c399 Mon Sep 17 00:00:00 2001 From: Simon H <5968653+dummdidumm@users.noreply.github.com> Date: Mon, 20 Feb 2023 20:36:26 +0100 Subject: [PATCH 3/3] Update packages/create-svelte/shared/+skeletonlib/README.md Co-authored-by: gtmnayan <50981692+gtm-nayan@users.noreply.github.com> --- packages/create-svelte/shared/+skeletonlib/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/create-svelte/shared/+skeletonlib/README.md b/packages/create-svelte/shared/+skeletonlib/README.md index c5a00d13e217..4fee31f6f8e6 100644 --- a/packages/create-svelte/shared/+skeletonlib/README.md +++ b/packages/create-svelte/shared/+skeletonlib/README.md @@ -49,7 +49,7 @@ You can preview the production build with `npm run preview`. ## Publishing -Go into the `package.json` and give your package the desired name through the `"name"` option. Also consider adding a `"license"` field and point it to a `license.md` file which you can create from a template (one popular option is the [MIT license](https://opensource.org/license/mit/)). +Go into the `package.json` and give your package the desired name through the `"name"` option. Also consider adding a `"license"` field and point it to a `LICENSE` file which you can create from a template (one popular option is the [MIT license](https://opensource.org/license/mit/)). To publish your library to [npm](https://www.npmjs.com):