From e967afae60c8da9468a14090a1570a3e2ecad8f3 Mon Sep 17 00:00:00 2001 From: Pehesi97 Date: Tue, 24 Oct 2023 21:21:59 -0300 Subject: [PATCH] fix: npm readme --- npm/README.md | 8 +------- npm/docs.md | 7 +++++++ 2 files changed, 8 insertions(+), 7 deletions(-) mode change 100644 => 120000 npm/README.md create mode 100644 npm/docs.md diff --git a/npm/README.md b/npm/README.md deleted file mode 100644 index 608e3902..00000000 --- a/npm/README.md +++ /dev/null @@ -1,7 +0,0 @@ -# Publish the initium CLI on NPM - -This folder is here to generate an npm package that will allow user to run initium with either npm or npx. - -NOTE: This package doesn't contain the binaries. - -You can check the code in the `script` folder to see how this package will detect the platform and architecture of your machine and download the relevant binary from the github releases of this repo. diff --git a/npm/README.md b/npm/README.md new file mode 120000 index 00000000..32d46ee8 --- /dev/null +++ b/npm/README.md @@ -0,0 +1 @@ +../README.md \ No newline at end of file diff --git a/npm/docs.md b/npm/docs.md new file mode 100644 index 00000000..608e3902 --- /dev/null +++ b/npm/docs.md @@ -0,0 +1,7 @@ +# Publish the initium CLI on NPM + +This folder is here to generate an npm package that will allow user to run initium with either npm or npx. + +NOTE: This package doesn't contain the binaries. + +You can check the code in the `script` folder to see how this package will detect the platform and architecture of your machine and download the relevant binary from the github releases of this repo.