readme

add .npmignore file
cleanup
2023-08-26 18:37:46 -07:00 · 2023-08-26 18:28:44 -07:00 · 2023-08-26 16:12:23 -07:00 · 2023-08-26 16:12:10 -07:00
2 changed files with 9 additions and 0 deletions
--- a/.npmignore
+++ b/.npmignore
@@ -0,0 +1,3 @@
+.gitea
+src
+tsconfig.json
--- a/readme.md
+++ b/readme.md
@@ -6,7 +6,13 @@ In-memory caching/memoization utilities
 ## Install

 ```bash
+# Update project npm config to refer to correct registry for the @js scope
+echo '@js:registry=https://gitea.jbrumond.me/api/packages/js/npm/' >> ./.npmrc
+
 npm install --save @js/memo
+
+# optional - additional supporting typescript definitions
+npm install --save-dev @js/types
 ```

 ## Usage
Author	SHA1	Message	Date
James Brumond	878592fbc6	readme All checks were successful Build and test / build-and-test (18.x) (push) Successful in 12s Details Build and test / build-and-test (20.x) (push) Successful in 17s Details	2023-08-26 18:37:46 -07:00
James Brumond	aa7272b0b4	add .npmignore file Some checks failed Build and test / build-and-test (18.x) (push) Successful in 12s Details Build and test / build-and-test (20.x) (push) Failing after 42s Details	2023-08-26 18:28:44 -07:00
James Brumond	0db015e91d	cleanup All checks were successful Build and test / build-and-test (18.x) (push) Successful in 13s Details Build and test / build-and-test (20.x) (push) Successful in 11s Details	2023-08-26 16:12:23 -07:00
James Brumond	7c93618c5c	publish All checks were successful Build and publish / build-and-publish (push) Successful in 16s Details	2023-08-26 16:12:10 -07:00