quick save: Fri Dec 27 13:02:39 MSK 2024

Author: nikelborm

README.md

@@ -8,26 +8,41 @@ This project allows you to download any folder inside a repo on github.
 
 You need to have installed latest node, git, npm
 
-## Initialization
+## Installation
 
-Execute this:
+### From GitHub NPM Registry
+
+1. [Generate `Personal access token (classic)` with `read:packages` scope](https://github.com/settings/tokens/new?description=Install%20packages%20from%20GitHub%20NPM%20registry&scopes=read:packages&default_expires_at=none)
+2. Save the token
+3. Run `npm login --auth-type=legacy --registry=https://npm.pkg.github.com` (read more about `--auth-type=legacy` [here](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-npm-registry#authenticating-with-a-personal-access-token))
+4. Enter your username when asked
+5. Paste the token as password value
+6. Then run `npm i @nikelborm/download-github-folder` to install the package
+
+### From default NPM registry
+
+Currently in despute with NPM's support over publishing it as `download-github-folder`
+
+### For local development
 
 ```bash
 # Clone this repo:
-git clone -b main --depth 1 https://github.com/nikelborm/download-github-folder.git
+git clone -b main https://github.com/nikelborm/download-github-folder.git
 # cd to it:
 cd download-github-folder
 # Install dependencies:
 npm install
 # Create .env file:
 cp template.env .env
+# Ask for token
+read -sp 'Enter github access token: ' gh_token; echo;
+# And immediately put it into .env
+sed -i "s/\(GITHUB_ACCESS_TOKEN\)='.*'/\1='$gh_token'/" .env
 ```
 
-Then [get personal github access token here](https://github.com/settings/tokens)
-
 ## Environment Variables
 
-- `GITHUB_ACCESS_TOKEN`: This is your personal access token from GitHub. It is used to authenticate your requests to the GitHub API. You can generate one from your GitHub account settings.
+- `GITHUB_ACCESS_TOKEN`: This is your personal access token from GitHub. It is used to authenticate your requests to the GitHub API. You can generate one [here](https://github.com/settings/tokens/new?description=Read%20repo%20contents%20access%20to%20download-github-folder&scopes=public_repo&default_expires_at=none).
 - `GITHUB_REPO_OWNER`: This is the username of the owner of the repository you are trying to download from. For example, if the repository's URL is `https://github.com/apache/superset`, the owner is `apache`.
 - `GITHUB_REPO_NAME`: This is the name of the repository you are trying to download from. In the example above, the repository name is `superset`.
 - `PATH_TO_DIRECTORY_IN_REPO`: This is the path to the directory you want to download. It can be directory that lies inside root of repo like `docker` or it can be some nested directory like `docker/nginx`.

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nikelborm/download-github-folder",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "type": "module",
   "description": "Download any directory at any depth from any repo on GitHub on any git ref",
   "license": "MIT",

template.env

@@ -1,4 +1,4 @@
-# Get here: https://github.com/settings/tokens
+# Get here: https://github.com/settings/tokens/new?description=Read%20repo%20contents%20access%20to%20download-github-folder&scopes=public_repo&default_expires_at=none
 GITHUB_ACCESS_TOKEN='ghp_1234567890abcdefghij'
 
 GITHUB_REPO_OWNER='apache'