Skip to content

Commit

Permalink
Create README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
nuance-dev authored Nov 1, 2024
1 parent e2f3dae commit 4ee0cf1
Showing 1 changed file with 59 additions and 0 deletions.
59 changes: 59 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
# Achico - A Free MacOS Native PDF Compressor

A lightweight, native macOS app that compresses PDF files while maintaining quality. Simple, fast, and efficient!

![image](https://github.com/user-attachments/assets/4e10b8a7-decc-4e0b-8b56-f88198e75ec9)


## Features
- **Smart PDF Compression**: Intelligently compresses PDFs while preserving readability
- **Multiple Input Methods**: Drag & drop or click to select files
- **Real-time Progress**: Watch your PDFs being compressed with a clean progress indicator
- **Compression Stats**: See how much space you've saved instantly
- **Dark and Light modes**: Seamlessly integrates with your system preferences
- **Native Performance**: Built with SwiftUI for optimal macOS integration

## 💻 Get Started
Download from the [releases](https://github.com/nuance-dev/Achico/releases/) page.

## ⚡️ How it Works
1. Drop or select your PDF
2. Watch the magic happen
3. Download your compressed file
4. That's it!

## 🛠 Technical Details
- Built natively for macOS using SwiftUI and PDFKit
- Utilizes advanced compression algorithms while maintaining PDF quality
- Efficient memory management for handling large files
- Clean, modern interface following Apple's design guidelines

## 🔮 Features Coming Soon
- Batch processing
- Custom compression levels
- Detailed file information
- Quick Look integration

## 🤝 Contributing
We welcome contributions! Here's how you can help:

1. Clone the repository
2. Create your feature branch (`git checkout -b feature/AmazingFeature`)
3. Commit your changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request

Please ensure your PR:
- Follows the existing code style
- Includes appropriate tests if applicable
- Updates documentation as needed

## 📝 License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

## 🔗 Links
- Report issues: [GitHub Issues](https://github.com/YourUsername/Achico/issues)
- Follow updates: [@YourTwitter](https://twitter.com/YourTwitterHandle)

## Requirements
- macOS 14.0 or later

0 comments on commit 4ee0cf1

Please sign in to comment.