# Publishing to crates.io
This guide helps you publish tiny-trae to crates.io for easy installation.
## Prerequisites
1. **Crates.io account**: Create an account at [crates.io](https://crates.io/)
2. **API token**: Get your API token from [crates.io/me](https://crates.io/me)
3. **Login to cargo**: Run `cargo login` and paste your API token
## Pre-publishing Checklist
### 1. Update Cargo.toml
Make sure these fields are correctly set:
```toml
[package]
name = "tiny-trae"
version = "0.1.0"
edition = "2021"
description = "An AI coding assistant with tool integration"
license = "MIT"
authors = ["Your Name <your.email@example.com>"]
repository = "https://github.com/your-username/tiny-trae"
homepage = "https://github.com/your-username/tiny-trae"
readme = "README.md"
keywords = ["ai", "coding", "assistant", "development", "tools"]
categories = ["development-tools", "command-line-utilities"]
```
### 2. Create LICENSE file
```bash
# Create MIT license file
cat > LICENSE << 'EOF'
MIT License
Copyright (c) 2024 Your Name
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
EOF
```
### 3. Clean up warnings
```bash
# Fix compiler warnings
cargo clippy --fix --allow-dirty --allow-staged
```
### 4. Run tests
```bash
cargo test
```
### 5. Check package
```bash
# Verify package contents
cargo package --list
# Test package build
cargo package --allow-dirty
```
## Publishing Steps
### 1. Login to crates.io
```bash
cargo login
# Paste your API token when prompted
```
### 2. Dry run
```bash
# Test publishing without actually publishing
cargo publish --dry-run
```
### 3. Publish
```bash
# Actually publish to crates.io
cargo publish
```
## Post-publishing
### 1. Update README
After successful publishing, update the README to include crates.io installation:
```markdown
#### Using Cargo (Recommended)
```bash
cargo install tiny-trae
```
#### From Source
```bash
git clone https://github.com/your-username/tiny-trae.git
cd tiny-trae
cargo install --path .
```
```
### 2. Update install scripts
Update install.sh and install.bat to use crates.io:
```bash
# In install.sh, replace git clone with:
echo "📦 Installing from crates.io..."
cargo install tiny-trae
```
### 3. Tag the release
```bash
git tag v0.1.0
git push origin v0.1.0
```
## Version Management
For future releases:
1. Update version in `Cargo.toml`
2. Update `CHANGELOG.md`
3. Run `cargo publish`
4. Tag the release
## Common Issues
### Missing files
- Ensure `LICENSE` file exists
- Ensure `README.md` is present
- Check that all source files are included
### Keywords/Categories
- Maximum 5 keywords
- Use valid categories from [crates.io/category_slugs](https://crates.io/category_slugs)
### Dependencies
- Make sure all dependencies are available on crates.io
- Remove any git or path dependencies
## Example commands
```bash
# Complete publishing workflow
cargo clippy --fix --allow-dirty --allow-staged
cargo test
cargo package --allow-dirty
cargo publish --dry-run
cargo publish
git tag v0.1.0
git push origin v0.1.0
```