diff --git a/README.md b/README.md index 2d28d9e..a8db2e4 100644 --- a/README.md +++ b/README.md @@ -2,21 +2,24 @@

- A template to assist you in creating and publishing TypeScript modules on NPM + 🚀 A starter for any TypeScript project meant to be published on NPM

-![image](https://user-images.githubusercontent.com/6702424/111089239-4012e480-852b-11eb-8351-df1610953d0c.png) +ts-ci is a project starter like [TSDX](https://github.com/formium/tsdx) or [typescript starter](https://github.com/bitjson/typescript-starter) but (arguably) better because +- It's not a CLI tool, the automation happens with Github Actions. Update your `package.json` version number, push. + Voila, your new version is published on NPM. +- It doesn't bundle your library into a single file so users can cherry-pick what they want to import from your lib. E.g: `import { aSpecificFunction } from "your-module/aSpecificFile`. +# How to use ---- +- Click on ![image](https://user-images.githubusercontent`com/6702424/98155461-92395e80-1ed6-11eb-93b2-98c64453043f.png) +- The repo name you will choose will be used as a module name for NPM. +- Go to the repository ``Settings`` tab, then ``Secrets`` you will need to add a new secret: +``NPM_TOKEN``, you NPM authorization token. +- To trigger publishing edit the ``package.json`` ``version`` field ( ``0.0.0``-> ``0.0.1`` for example) then push changes... that's all ! -✅ NEW: The workflow is now fully portable. -✅ NEW: Only one secret has to be defined: `NPM_TOKEN` (to enable publishing on your behalf on NPM). -✅ NEW: `yarn` support, if you prefer `npm`, just delete `yarn.lock`. -✅ NEW: React ready ( `tsconfig.json` configured to transpile `.tsx` files). - -# Presentation +# Features This template automates the boring and tedious tasks of: - Filling up the ``package.json`` @@ -34,263 +37,33 @@ Besides, good stuff that comes with using this template: - CDN distribution for importing from an ``.html`` file with a `` - -``` - -Or import it as an ES module: - -```html - -``` - -_You can specify the version you wish to import:_ [unpkg.com](https://unpkg.com) - -## Contribute - -```bash -npm install -npm run build -npm test -``` +``` \ No newline at end of file diff --git a/package.json b/package.json index 8d8b3ec..94c7571 100755 --- a/package.json +++ b/package.json @@ -43,13 +43,13 @@ "homepage": "https://github.com/#{USER_OR_ORG}#/#{REPO_NAME}#", "devDependencies": { "@types/node": "^16.4.9", + "typescript": "^4.3.5", "@typescript-eslint/eslint-plugin": "^4.28.5", "@typescript-eslint/parser": "^4.28.5", "eslint": "^7.32.0", "eslint-config-prettier": "^8.3.0", "husky": "^4.3.8", "lint-staged": "^11.1.1", - "prettier": "^2.3.2", - "typescript": "^4.3.5" + "prettier": "^2.3.2" } }