feat: update README

This commit is contained in:
junchi.zhang
2025-04-26 16:37:48 +08:00
parent 08646a8157
commit 4f1215e654
3 changed files with 197 additions and 6 deletions
+75 -1
View File
@@ -4,8 +4,82 @@
Website[https://pinme.eth.limo/](https://pinme.eth.limo/)
## Features
# PinMe Deploy Docs
- 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>`
- PinMe Gateway: `https://gateway.pinme.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 ./
+72 -1
View File
@@ -4,7 +4,78 @@
Website[https://pinme.eth.limo/](https://pinme.eth.limo/)
# pPinMeinme Deploy Blog
## 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 Deploy Blog
This is a Hugo-based static blog project that can be easily deployed to the IPFS network.
## Project Structure
```
./
├── content/ # Blog content directory
├── themes/ # Hugo themes directory
├── layouts/ # Custom layouts directory
├── static/ # Static assets directory
└── public/ # Build output directory
```
## Prerequisites
- [Hugo](https://gohugo.io/) (Static site generator) installed
- PinMe tool installed
## Local Preview
```bash
# Start Hugo server for local preview
hugo server -D
```
## Build and Deploy
```bash
# Build the static site
hugo
# Upload the built site to IPFS
pinme upload ./public
```
## After Deployment
After successful deployment, PinMe will output the CID and access links. You can access your blog via:
- IPFS Gateway: `https://ipfs.io/ipfs/<your-CID>`
- PinMe Gateway: `https://gateway.pinme.io/ipfs/<your-CID>`
- Or set up a custom domain
## Custom Domain
To access your blog with a custom domain, refer to the DNSLink setup guide in the PinMe documentation.
## Contributing
Issues and Pull Requests are welcome to help improve this project.
## License
MIT
```bash
hugo build
+50 -4
View File
@@ -4,24 +4,70 @@
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
Before using this deployment blog, please install the PinMe tool:
```bash
npm install -g pinme
# or
yarn global add pinme
```
# PinMe Deploy Blog
## Install
This is a Supabase-based blog project that can be easily deployed to the IPFS network.
## Project Structure
```
./
├── src/ # Source code directory
├── public/ # Static assets directory
├── components/ # Components directory
└── dist/ # Build output directory
```
## Installation
```bash
pnpm install
```
## Preview
## Local Preview
```bash
pnpm run dev
```
## Build
## Build Project
```bash
pnpm run build
```
## Deploy
## Deploy to IPFS
```bash
pinme upload ./dist
```
## After Deployment
After successful deployment, PinMe will output the CID and access links. You can access your blog via:
- IPFS Gateway: `https://ipfs.io/ipfs/<your-CID>`
- PinMe Gateway: `https://gateway.pinme.io/ipfs/<your-CID>`
- Or set up a custom domain (see PinMe documentation)
## Contributing
Issues and Pull Requests are welcome to help improve this project.
## License
MIT