From 97de538bec495751fc7da3173f252ade722af839 Mon Sep 17 00:00:00 2001 From: Christopher Pfohl Date: Fri, 14 Jun 2019 09:28:07 -0400 Subject: [PATCH 1/2] Suggest using degit for starting out --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index c77692d..f81ffa4 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,18 @@ console.log('it will be lunchtime in ' + howLongTillLunch()); ## Getting started +### Degit + +The easiest way to use this as a base project is to use [degit](Rich-Harris/degit)! + +```bash +npx degit https://github.com/rollup/rollup-starter-lib my-library +cd my-library +npm install +``` + +### Clone + Clone this repository and install its dependencies: ```bash @@ -20,6 +32,10 @@ cd rollup-starter-lib npm install ``` +*Note:* this technique keeps the git history from this repository, which you probably do not want in your library. + +## Using rollup-starter-lib + `npm run build` builds the library to `dist`, generating three files: * `dist/how-long-till-lunch.cjs.js` From 0ea557cc07e8faf98ef4a78620ffda6f5bda3824 Mon Sep 17 00:00:00 2001 From: Christopher Pfohl Date: Mon, 13 Feb 2023 11:54:18 -0500 Subject: [PATCH 2/2] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index f81ffa4..d4e0425 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ console.log('it will be lunchtime in ' + howLongTillLunch()); The easiest way to use this as a base project is to use [degit](Rich-Harris/degit)! ```bash -npx degit https://github.com/rollup/rollup-starter-lib my-library +npx degit rollup/rollup-starter-lib my-library cd my-library npm install ```