From 8b99037a21c5f84885fe8fffbfd25e8e209c29cf Mon Sep 17 00:00:00 2001 From: Garrone Joseph Date: Sat, 27 Feb 2021 22:34:01 +0100 Subject: [PATCH 01/11] Update README.md --- README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/README.md b/README.md index a598a27..20683f7 100644 --- a/README.md +++ b/README.md @@ -73,7 +73,6 @@ If you want your module to support Deno as well checkout [denoify_ci](https://gi Once you've done that a GitHub action workflow will set up the ``README.md`` and the ``package.json`` for you, wait a couple of minutes for it to complete ( a bot will push ). You can follow the job advancement in the "Action" tab. -(**warning** please read [this](#few-things-you-need-to-be-aware-of-before-getting-started)) Each time you will push changes ``npm test`` will be run on remote docker containers against multiple node versions if everything passes you will get a green ``ci`` badges in your readme. From 716bba4dd1a8fcb02e0b23745cfa088ebc89f158 Mon Sep 17 00:00:00 2001 From: Garrone Joseph Date: Sat, 27 Feb 2021 22:36:28 +0100 Subject: [PATCH 02/11] Update README.md --- README.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 20683f7..9525072 100644 --- a/README.md +++ b/README.md @@ -90,10 +90,9 @@ The publishing will actually be performed only if ``npm test`` passes. # Few things you need to be aware of before getting started -- You probably want to "Use this template" ( the green button ) instead of forking the repo. - The files to include in the NPM bundle are cherry-picked using the ``package.json`` ``files`` field. If you don't want to bother and includes everything just remove the ``files`` field from the ``package.json``. -- If you are going to programmatically load files outside of the ``dis/`` directory ( like the ``package.json`` or files inside ``res/`` ) be mindful that the paths might not be the one you expect. [Details](#accessing-files-outside-the-dist-directory). +- If you are going to programmatically load files outside of the ``dist/`` directory ( like the ``package.json`` or files inside ``res/`` ) be mindful that the paths might not be the one you expect. [Details](#accessing-files-outside-the-dist-directory). - The template does not support ``.npmignore`` ( it use the safer ``package.json`` ``files`` instead ). - The template does not support ``.npmrc``. @@ -168,7 +167,7 @@ Twitter or Reddit you don't get your GitHub profile picture to show up. [Prettier](https://prettier.io) is opinionated, it is OK to want to break free from it. -Remove these ``package.json``'s ``scripts``: +Remove these ``scripts`` from ``package.json``: - ``_format`` - ``format`` - ``format:check`` From 69cfb5bc40a6e3b21db251c400eccaae263fb384 Mon Sep 17 00:00:00 2001 From: Garrone Joseph Date: Sat, 27 Feb 2021 22:38:20 +0100 Subject: [PATCH 03/11] Update README.md --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 9525072..46a5e45 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,7 @@ --- ✅ NEW: `yarn` support You are now free to use yarn instead of `npm` if you'd like to. +✅ NEW: React ready ( `tsconfig.json` configured to transpile `.tsx` files). # Presentation From 5b1a4a15cb8b2e9ecb66ce7dc827a9e6f599b29f Mon Sep 17 00:00:00 2001 From: Garrone Joseph Date: Sat, 27 Feb 2021 22:38:43 +0100 Subject: [PATCH 04/11] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 46a5e45..4acdac2 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ --- -✅ NEW: `yarn` support You are now free to use yarn instead of `npm` if you'd like to. +✅ NEW: `yarn` support You are now free to use `yarn` instead of `npm` if you'd like to. ✅ NEW: React ready ( `tsconfig.json` configured to transpile `.tsx` files). # Presentation From b276c7feef8342c051e2434da3c7511ef444c980 Mon Sep 17 00:00:00 2001 From: Garrone Joseph Date: Sun, 28 Feb 2021 10:32:34 +0100 Subject: [PATCH 05/11] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 4acdac2..e303444 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,7 @@ This template automates the boring and tedious tasks of: - Publishing on NPM and creating corresponding GitHub releases. Besides, good stuff that comes with using this template: -- No dist files are tracked on the ``master`` branch. +- No dist files are tracked on the ``main`` branch. - Shorter specific file import path. ``import {...} from "my_module/theFile"`` instead of the usual ``import {...} from "my_module/dist/theFile"`` From 1ef27a665034466122631588186c34bd7634ce85 Mon Sep 17 00:00:00 2001 From: Garrone Joseph Date: Sun, 28 Feb 2021 10:38:55 +0100 Subject: [PATCH 06/11] Update README.md --- README.md | 66 +++++++++++++++++++++++++++---------------------------- 1 file changed, 32 insertions(+), 34 deletions(-) diff --git a/README.md b/README.md index e303444..cab7787 100644 --- a/README.md +++ b/README.md @@ -23,15 +23,13 @@ This template automates the boring and tedious tasks of: - Publishing on NPM and creating corresponding GitHub releases. Besides, good stuff that comes with using this template: -- No dist files are tracked on the ``main`` branch. +- No `dist/` directory tracked on the ``main`` branch. - Shorter specific file import path. ``import {...} from "my_module/theFile"`` instead of the usual ``import {...} from "my_module/dist/theFile"`` -- CDN distribution for importing from an ``.html`` file with a ``