pinme 1.2.0 → 1.2.2-alpha.1

package/README.md

@@ -16,7 +16,7 @@
 [PinMe](https://pinme.eth.limo/) is a zero-config frontend deployment tool.
 No servers. No accounts. No setup.
 
-Build a static site, generate a page with AI, or export your frontend — then deploy instantly with a single command.
+Build a static site, generate a page with AI, export your frontend, or import CAR files — 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.
 
@@ -25,7 +25,6 @@ PinMe handles availability and persistence for you.
 
 Website: [https://pinme.eth.limo/](https://pinme.eth.limo/)
 
-
 ## Installation
 
 ### Using npm
@@ -56,6 +55,20 @@ pinme upload /path/to/file-or-directory --domain <name>
 pinme upload /path/to/file-or-directory -d <name>
 ```
 
+### Import CAR files
+
+```bash
+# Interactive CAR import
+pinme import
+
+# Specify CAR file path directly
+pinme import /path/to/car-file.car
+
+# Import CAR file and bind to a domain
+pinme import /path/to/car-file.car --domain <name>
+pinme import /path/to/car-file.car -d <name>
+```
+
 ### Remove files from IPFS
 
 ```bash
@@ -92,6 +105,23 @@ pinme set-appkey
 pinme set-appkey <AppKey>
 ```
 
+### View AppKey information
+
+```bash
+# Show current AppKey (masked for security)
+pinme show-appkey
+
+# Or use the shorthand command
+pinme appkey
+```
+
+### Log out
+
+```bash
+# Log out and clear authentication
+pinme logout
+```
+
 ### View your domains
 
 ```bash
@@ -120,10 +150,12 @@ 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
 # Interactive upload
 pinme upload
@@ -139,6 +171,37 @@ pinme upload ./my-website --domain my-site
 pinme upload ./my-website -d my-site
 ```
 
+### `import`
+
+Import CAR (Content Addressable aRchive) files to the IPFS network. This command is specifically designed for importing CAR files while maintaining their original structure. Supports binding to a Pinme subdomain after import.
+
+```bash
+pinme import [path] [--domain <name>]
+```
+
+**Options:**
+- `path`: Path to the CAR file to import (optional, if not provided, interactive mode will be entered)
+- `-d, --domain <name>`: Pinme subdomain to bind after import (optional)
+
+**Examples:**
+```bash
+# Interactive CAR import
+pinme import
+
+# Import a specific CAR file
+pinme import ./my-archive.car
+
+# Import CAR file and bind to a domain
+pinme import ./my-archive.car --domain my-archive
+pinme import ./my-archive.car -d my-archive
+```
+
+**Key Differences from `upload`:**
+- CAR files are imported with their original structure preserved
+- Uses IPFS CAR import protocol for efficient content addressing
+- Ideal for importing previously exported IPFS content
+- Same domain binding and management features as `upload`
+
 ### `rm`
 
 Remove a file from the IPFS network.
@@ -148,9 +211,11 @@ pinme rm [hash]
 ```
 
 **Options:**
+
 - `hash`: IPFS content hash to remove (optional, if not provided, interactive mode will be entered)
 
 **Examples:**
+
 ```bash
 # Interactive removal
 pinme rm
@@ -171,10 +236,12 @@ pinme ls [options]
 ```
 
 **Options:**
+
 - `-l, --limit <number>`: Limit the number of records displayed
 - `-c, --clear`: Clear all upload history
 
 **Examples:**
+
 ```bash
 # Show the last 10 records
 pinme list
@@ -195,9 +262,11 @@ 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
@@ -208,6 +277,55 @@ pinme set-appkey your-app-key-here
 
 **Note:** After setting the AppKey, your anonymous upload history will be automatically merged to your account.
 
+### `show-appkey` / `appkey`
+
+Display current AppKey information with masked sensitive data.
+
+```bash
+pinme show-appkey
+pinme appkey
+```
+
+**Description:**
+
+This command shows the current AppKey information including:
+- Address (fully displayed)
+- Token (masked for security)
+- AppKey (masked for security)
+
+**Examples:**
+
+```bash
+# Show AppKey information
+pinme show-appkey
+
+# Shorthand command
+pinme appkey
+```
+
+**Note:** Sensitive information (token and AppKey) will be masked to protect your credentials. Only the address is fully displayed.
+
+### `logout`
+
+Log out and clear authentication information from local storage.
+
+```bash
+pinme logout
+```
+
+**Description:**
+
+This command logs out the current user and removes the authentication information from local storage. After logging out, you will need to set your AppKey again to use authenticated features.
+
+**Examples:**
+
+```bash
+# Log out
+pinme logout
+```
+
+**Note:** This action will remove your AppKey from local storage. You can set it again using `pinme set-appkey` command.
+
 ### `my-domains` / `domain`
 
 List all domains owned by the current account.
@@ -218,6 +336,7 @@ pinme domain
 ```
 
 **Examples:**
+
 ```bash
 # List all domains
 pinme my-domains
@@ -227,6 +346,7 @@ pinme domain
 ```
 
 This command displays information about each domain including:
+
 - Domain name
 - Domain type
 - Bind time
@@ -241,9 +361,11 @@ pinme help [command]
 ```
 
 **Options:**
+
 - `command`: The specific command to view help for (optional)
 
 **Examples:**
+
 ```bash
 # Display general help
 pinme help
@@ -251,8 +373,8 @@ pinme help
 
 ## Upload Limits
 
-- Single file size limit: 20MB
-- Total directory size limit: 500MB
+- Single file size limit: 200MB (free plan)
+- Total directory size limit: 1GB (free plan)
 
 ## File Storage
 
@@ -264,10 +386,10 @@ Uploaded files are stored on the IPFS network and accessible through the Glitter
 ### Log Locations
 
 Logs and configuration files are stored in:
+
 - Linux/macOS: `~/.pinme/`
 - Windows: `%USERPROFILE%\.pinme\`
 
-
 ## License
 
 MIT License - See the [LICENSE](LICENSE) file for details
@@ -283,11 +405,20 @@ When uploading projects built with Vite, please note:
 ```js
 // vite.config.js
 export default {
-  base: "./",
+  base: './',
   // other configurations...
-}
+};
 ```
 
+### Working with CAR Files
+
+When using the `import` command for CAR files:
+
+1. **CAR File Format**: Ensure your files have the `.car` extension and follow the IPFS CAR specification
+2. **Content Integrity**: CAR files preserve the original content structure and CID relationships
+3. **Use Cases**: Ideal for importing previously exported IPFS content, migrating between IPFS nodes, or batch content transfers
+4. **Size Considerations**: CAR files can be large, ensure you have sufficient bandwidth and storage space
+
 ## 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.
@@ -295,10 +426,12 @@ PinMe can be integrated with GitHub Actions to automatically deploy your project
 ### 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
@@ -326,6 +459,7 @@ The GitHub Actions workflow automatically:
 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/)
 
@@ -390,18 +524,25 @@ The workflow automatically detects and supports:
 ### 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
 
+## Star History
+
+[![Star History Chart](https://api.star-history.com/svg?repos=glitternetwork/pinme&type=Date)](https://star-history.com/#glitternetwork/pinme&Date)
+
 ## Contact Us
 
 If you have questions or suggestions, please contact us through: