From c41dfd788218f3c3c08b68381ae758ae69314742 Mon Sep 17 00:00:00 2001 From: sebkolind Date: Thu, 1 Aug 2024 08:37:50 +0200 Subject: [PATCH] docs(readme): update Usage --- README.md | 17 ++++++++++++----- 1 file changed, 12 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 142c401..d426eea 100644 --- a/README.md +++ b/README.md @@ -19,17 +19,24 @@ It is primarily for me, but if you find it useful, that's great! ```sh # Clone the template locally -git clone git@github.com:sebkolind/ts-lib-starter.git ./my-project +git clone git@github.com:sebkolind/ts-lib-starter.git my-project -# Install dependencies +# Change working directory to your project cd my-project -npm add ``` -Now, you can use any of the `npm` commands: +### Configure package + +Now, remember to open the `package.json` file and change the `name` to your libraries name, and the `description` +to something related to your project. + +### Start building ```sh -# Devlopement +# Install dependencies +npm install + +# Development npm run dev # Run tests