chore: import upstream snapshot with attribution

2026-07-13 12:30:28 +08:00
commit ba73d7ef36
160 changed files with 37714 additions and 0 deletions
@@ -0,0 +1,85 @@
+# PinMe
+
+[PinMe](https://pinme.eth.limo/) is a simple and easy-to-use command-line tool for uploading files and directories to the [IPFS](https://ipfs.tech/) network.
+
+Website: [https://pinme.eth.limo/](https://pinme.eth.limo/)
+
+## Features
+
+- Simple and intuitive command-line interface
+- Fast uploading of files and directories to IPFS
+- Automatic generation and display of access links
+- Built-in Pinning service integration for persistent content
+- Support for various configuration options
+
+## Installing PinMe
+
+```bash
+npm install -g pinme
+# or
+yarn global add pinme
+```
+
+# PinMe Documentation Project
+
+This is the official documentation project for the PinMe tool, containing detailed user guides, API references, and best practices.
+
+## Documentation Structure
+
+```
+./
+├── guide/        # User guide directory
+├── api/          # API reference documentation
+├── examples/     # Example code and use cases
+├── images/       # Documentation image resources
+└── index.md      # Documentation homepage
+```
+
+## Local Preview
+
+You can preview the documentation using any static web server:
+
+```bash
+# Using Python's simple HTTP server
+python -m http.server
+
+# Or using Node.js http-server
+npx http-server ./
+```
+
+## Deploy Documentation to IPFS
+
+```bash
+# Upload the entire documentation directory to IPFS
+pinme upload ./
+```
+
+## After Deployment
+
+After successful deployment, PinMe will output the CID and access links. You can access the documentation via:
+
+- IPFS Gateway: `https://ipfs.io/ipfs/<your-CID>`
+
+## Updating Documentation
+
+1. Modify the relevant Markdown files
+2. Redeploy to IPFS
+3. Update DNSLink to point to the new CID (if using a custom domain)
+
+## Contributing to Documentation
+
+We welcome community contributions to the documentation:
+
+1. Fork this repository
+2. Create your feature branch (`git checkout -b feature/amazing-doc`)
+3. Commit your changes (`git commit -m 'Add some amazing doc'`)
+4. Push to the branch (`git push origin feature/amazing-doc`)
+5. Open a Pull Request
+
+## License
+
+MIT
+
+```bash
+pinme upload ./
+```
@@ -0,0 +1,2 @@
+* [Home](/)
+* [Contact](./contact/index.md)
@@ -0,0 +1,5 @@
+ * [Home](./)
+ * [Quick Start](./quickstart)
+ * Guide
+    * [Install](./guide/installation)
+    * [Config](./guide/config)
@@ -0,0 +1,3 @@
+ * [Contact](./contact/index)
+ * [test](./contact/test)
+
@@ -0,0 +1,3 @@
+# Contact
+
+[Glitter](https://glitterprotocol.io/)
@@ -0,0 +1,3 @@
+# test
+
+test page
@@ -0,0 +1,2 @@
+# config
+pinme -help
@@ -0,0 +1,5 @@
+# install
+
+```bash
+npm -g install pinme
+```
@@ -0,0 +1,28 @@
+<!DOCTYPE html>
+<html lang="en">
+
+<head>
+  <meta charset="UTF-8">
+  <title>Document</title>
+  <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
+  <meta name="description" content="Description">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0">
+  <link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify@4/lib/themes/vue.css">
+</head>
+
+<body>
+  <div id="app"></div>
+  <script>
+    window.$docsify = {
+      name: 'PINME',
+      repo: 'https://github.com/glitternetwork/pinme',
+      themeColor: '#2ecc71',
+      loadNavbar: '_navbar.md',
+      loadSidebar: '_sidebar.md',
+    }
+  </script>
+  <!-- Docsify v4 -->
+  <script src="//cdn.jsdelivr.net/npm/docsify@4"></script>
+</body>
+
+</html>
@@ -0,0 +1,2 @@
+# Quick Start
+quick start