repolet 0.1.0 → 0.1.2

package/README.md

@@ -1,129 +1,74 @@
 Repolet
 
-Copy a complete GitHub repository or a specific GitHub folder directly to your local filesystem.
+Copy a GitHub repository or any subfolder directly to your local machine.
 
-Repolet does not create a ZIP file and does not copy the .git history. It downloads the actual files into a normal local directory.
 
-Features
 
-Copy an entire GitHub repository
-
-Copy only a specific GitHub subfolder
-
-Support nested folders
-
-Preserve binary files such as PNG, PDF, MP3, SVG, etc.
-
-Custom destination folder
-
-Recursive file discovery
-
-GitHub token support
-
-Download progress
-
-Existing-folder protection
-
-Installation
-
-Using npm:
+🚀 Install
 
 npm install -g repolet
 
-Using pnpm:
-
-pnpm add -g repolet
-
-Or run directly with:
+Or use without installing:
 
 npx repolet <github-url>
 
-Usage
-
-Copy an entire repository
+📦 Usage
 
-repolet https://github.com/user/repository
+Copy a repository:
 
-For example:
+repolet https://github.com/facebook/react
 
-repolet https://github.com/Devendradhote001/KODR4-React kodr-repo
+Copy a specific folder:
 
-Creates:
+repolet https://github.com/expressjs/express/tree/master/lib
 
-kodr-repo/
-├── public/
-├── src/
-├── package.json
-└── ...
+Choose a destination:
 
-Copy a specific folder
+repolet https://github.com/expressjs/express/tree/master/lib my-lib
 
-repolet https://github.com/user/repository/tree/main/src my-src
+✨ Features
 
-For example:
+Copy full repositories or selected folders
 
-repolet https://github.com/shivsingh78/my-portfolio/tree/main/src my-portfolio-src
+Recursively copy nested directories
 
-Creates:
+Supports binary files such as PNG, PDF, MP3, and SVG
 
-my-portfolio-src/
-├── App.jsx
-├── assets/
-├── components/
-├── index.css
-└── main.jsx
+Supports GitHub branches
 
-Destination is optional
+Optional GITHUB_TOKEN authentication
 
-repolet https://github.com/user/repository/tree/main/src
+Protects existing destination folders
 
-Repolet will use the selected folder name as the destination.
+No ZIP files and no .git history
 
-GitHub Authentication
+🔐 Authentication
 
-Public repositories can be downloaded without authentication.
+Public repositories work without a token.
 
-For private repositories or higher GitHub API limits, set a GitHub fine-grained personal access token:
+For private repositories:
 
 export GITHUB_TOKEN="your_token"
 
-Then:
-
-repolet https://github.com/user/private-repo private-repo
-
-The token is read from:
-
-GITHUB_TOKEN
-
-Repolet does not store the token.
+Windows PowerShell:
 
-For a fine-grained token, use the minimum required repository permissions, such as:
+$env:GITHUB_TOKEN="your_token"
 
-Contents → Read-only
+Use a GitHub fine-grained token with Contents: Read-only.
 
-Options
+⚙️ Options
 
 repolet --help
 repolet --version
 
-Examples
-
-Copy a complete repository:
-
-repolet https://github.com/user/repository
-
-Copy a folder:
-
-repolet https://github.com/user/repository/tree/main/components
-
-Copy to a custom directory:
+🧰 Requirements
 
-repolet https://github.com/user/repository/tree/main/components ui-components
+Node.js 18+
 
-Requirements
+Internet connection
 
-Node.js 18 or newer
+📄 License
 
-License
+MIT
 
-MIT
+Repolet — take the part of GitHub you actually need.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "repolet",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "Copy a complete GitHub repository or a specific folder directly to your local filesystem",
   "type": "module",
   "main": "src/index.js",
@@ -26,8 +26,5 @@
   "engines": {
     "node": ">=18"
   },
-  "license": "MIT",
-  "dependencies": {
-    "repolet": "file:/home/shivsingh/harikirat/repolet/repolet-0.1.0.tgz"
-  }
+  "license": "MIT"
 }