pinme 1.1.6-alpha.4 → 1.2.0

package/README.md

@@ -13,9 +13,17 @@
 
 # PinMe
 
-[PinMe](https://pinme.eth.limo/) is a one-command deploy tool that turns static sites into permanent, verifiable frontends by pinning to [IPFS](https://ipfs.tech/), writing contenthash to [ENS](https://ens.domains/) subnames, and serving through gateways like [eth.limo](https://eth.limo/)—no DNS, no servers.
+[PinMe](https://pinme.eth.limo/) is a zero-config frontend deployment tool.
+No servers. No accounts. No setup.
 
-Website：[https://pinme.eth.limo/](https://pinme.eth.limo/)
+Build a static site, generate a page with AI, or export your frontend — then deploy instantly with a single command.
+
+PinMe publishes your site as verifiable content, making silent tampering and accidental breakage far harder than traditional hosting.
+
+You don’t manage servers, regions, or uptime.
+PinMe handles availability and persistence for you.
+
+Website: [https://pinme.eth.limo/](https://pinme.eth.limo/)
 
 
 ## Installation
@@ -42,6 +50,10 @@ pinme upload
 
 # Specify path directly
 pinme upload /path/to/file-or-directory
+
+# Upload and bind to a domain
+pinme upload /path/to/file-or-directory --domain <name>
+pinme upload /path/to/file-or-directory -d <name>
 ```
 
 ### Remove files from IPFS
@@ -70,6 +82,26 @@ pinme list -l 5
 pinme list -c
 ```
 
+### Set AppKey for authentication
+
+```bash
+# Interactive AppKey setup
+pinme set-appkey
+
+# Set AppKey directly
+pinme set-appkey <AppKey>
+```
+
+### View your domains
+
+```bash
+# List all domains owned by current account
+pinme my-domains
+
+# Or use the shorthand command
+pinme domain
+```
+
 ### Get help
 
 ```bash
@@ -81,14 +113,15 @@ pinme help
 
 ### `upload`
 
-Upload a file or directory to the IPFS network.
+Upload a file or directory to the IPFS network. Supports binding to a Pinme subdomain after upload.
 
 ```bash
-pinme upload [path]
+pinme upload [path] [--domain <name>]
 ```
 
 **Options:**
 - `path`: Path to the file or directory to upload (optional, if not provided, interactive mode will be entered)
+- `-d, --domain <name>`: Pinme subdomain to bind after upload (optional)
 
 **Examples:**
 ```bash
@@ -100,6 +133,10 @@ pinme upload ./example.jpg
 
 # Upload an entire directory
 pinme upload ./my-website
+
+# Upload and bind to a domain
+pinme upload ./my-website --domain my-site
+pinme upload ./my-website -d my-site
 ```
 
 ### `rm`
@@ -149,6 +186,52 @@ pinme ls -l 5
 pinme list -c
 ```
 
+### `set-appkey`
+
+Set AppKey for authentication and automatically merge anonymous upload history to the current account.
+
+```bash
+pinme set-appkey [AppKey]
+```
+
+**Options:**
+- `AppKey`: Your AppKey for authentication (optional, if not provided, interactive mode will be entered)
+
+**Examples:**
+```bash
+# Interactive AppKey setup
+pinme set-appkey
+
+# Set AppKey directly
+pinme set-appkey your-app-key-here
+```
+
+**Note:** After setting the AppKey, your anonymous upload history will be automatically merged to your account.
+
+### `my-domains` / `domain`
+
+List all domains owned by the current account.
+
+```bash
+pinme my-domains
+pinme domain
+```
+
+**Examples:**
+```bash
+# List all domains
+pinme my-domains
+
+# Shorthand command
+pinme domain
+```
+
+This command displays information about each domain including:
+- Domain name
+- Domain type
+- Bind time
+- Expire time
+
 ### `help`
 
 Display help information.
@@ -205,11 +288,125 @@ export default {
 }
 ```
 
+## GitHub Actions Integration
+
+PinMe can be integrated with GitHub Actions to automatically deploy your project when you push code to GitHub. This enables a fully automated CI/CD workflow.
+
+### Quick Setup
+
+1. **Add the workflow file** to your repository:
+   - Copy `.github/workflows/deploy.yml` from the PinMe repository to your project
+   - Or create `.github/workflows/deploy.yml` in your repository
+
+2. **Configure GitHub Secrets**:
+   - Go to your repository → Settings → Secrets and variables → Actions
+   - Add a new secret named `PINME_APPKEY` with your PinMe AppKey
+   - (Optional) Add `PINME_DOMAIN` to specify a custom domain name
+
+3. **Push to trigger deployment**:
+   - Push code to `main` or `master` branch to trigger automatic deployment
+   - Or manually trigger via Actions tab → "Deploy to PinMe" → Run workflow
+
+### Workflow Features
+
+The GitHub Actions workflow automatically:
+
+- ✅ Detects and installs project dependencies
+- ✅ Builds your project (if a build script exists)
+- ✅ Installs PinMe CLI
+- ✅ Sets up authentication using your AppKey
+- ✅ Auto-detects build output directory (`dist`, `build`, `public`, or `out`)
+- ✅ Uploads to IPFS and binds to your domain
+- ✅ Provides deployment summary with access URL
+
+### Configuration Options
+
+#### Using GitHub Secrets
+
+You can configure the following secrets in your repository:
+
+- **`PINME_APPKEY`** (Required): Your PinMe AppKey for authentication
+  - Format: `<address>-<jwt>`
+  - Get your AppKey from [PinMe website](https://pinme.eth.limo/)
+
+- **`PINME_DOMAIN`** (Optional): Default domain name to bind
+  - If not set, the workflow will generate a domain from your repository name
+  - Example: `my-awesome-project` → `https://my-awesome-project.pinit.eth.limo`
+
+#### Manual Workflow Dispatch
+
+You can also manually trigger the workflow with custom parameters:
+
+1. Go to Actions tab in your repository
+2. Select "Deploy to PinMe" workflow
+3. Click "Run workflow"
+4. Enter:
+   - **Domain**: Your desired PinMe domain name
+   - **Build Directory**: Your build output directory (default: `dist`)
+
+### Example Workflow
+
+```yaml
+name: Deploy to PinMe
+
+on:
+  push:
+    branches: [main, master]
+  workflow_dispatch:
+    inputs:
+      domain:
+        description: 'PinMe domain name'
+        required: true
+      build_dir:
+        description: 'Build directory'
+        default: 'dist'
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: '18'
+      - run: npm ci
+      - run: npm run build
+      - run: npm install -g pinme
+      - run: pinme set-appkey "${{ secrets.PINME_APPKEY }}"
+      - run: pinme upload dist --domain "${{ secrets.PINME_DOMAIN }}"
+```
+
+### Supported Build Tools
+
+The workflow automatically detects and supports:
+
+- **Vite**: Builds to `dist/`
+- **Create React App**: Builds to `build/`
+- **Next.js**: Builds to `out/` (with `output: 'export'`)
+- **Vue CLI**: Builds to `dist/`
+- **Angular**: Builds to `dist/`
+- **Static sites**: Uses root directory or `public/`
+
+### Troubleshooting
+
+**Build directory not found:**
+- Ensure your build script outputs to a standard directory (`dist`, `build`, `public`, or `out`)
+- Or set `PINME_DOMAIN` secret and use manual workflow dispatch to specify custom directory
+
+**Authentication failed:**
+- Verify your `PINME_APPKEY` secret is correctly set
+- Ensure the AppKey format is correct: `<address>-<jwt>`
+
+**Domain binding failed:**
+- Check if the domain name is available
+- Ensure you have permission to bind the domain
+- Try a different domain name
+
 ## Contact Us
 
 If you have questions or suggestions, please contact us through:
 
-- GitHub Issues: [https://github.com/glitternetwork/pinme/issues](https://github.com/glitternetwork/pinme/issue)
+- GitHub Issues: [https://github.com/glitternetwork/pinme/issues](https://github.com/glitternetwork/pinme/issues)
 - Email: [pinme@glitterprotocol.io](mailto:pinme@glitterprotocol.io)
 
 ---

package/dist/index.js

@@ -1523,7 +1523,7 @@ var import_chalk9 = __toESM(require("chalk"));
 var import_figlet3 = __toESM(require("figlet"));
 
 // package.json
-var version = "1.1.6-alpha.4";
+var version = "1.2.0";
 
 // bin/upload.ts
 var import_path6 = __toESM(require("path"));
@@ -4592,12 +4592,12 @@ var StepProgressBar = class {
   }
   completeStep() {
   }
-  // 开始模拟进度，用于在90%后继续显示进度
+  // Start simulating progress to continue display after 90%
   startSimulatingProgress() {
     this.isSimulatingProgress = true;
     this.simulationStartTime = Date.now();
   }
-  // 停止模拟进度
+  // Stop simulating progress
   stopSimulatingProgress() {
     this.isSimulatingProgress = false;
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pinme",
-  "version": "1.1.6-alpha.4",
+  "version": "1.2.0",
   "publishConfig": {
     "access": "public"
   },