Skip to content

Commit

Permalink
Create README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Ghost0159 committed Nov 21, 2024
1 parent 4cb0050 commit 6b3d707
Showing 1 changed file with 68 additions and 0 deletions.
68 changes: 68 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
# NX Content Tracker

A modern web application for tracking Nintendo Switch content, built with React and TypeScript.

## Features

- ๐ŸŽฎ Track base games, updates, and DLC content
- ๐Ÿ” Advanced search with configurable precision
- ๐ŸŒ“ Dark/Light theme support
- ๐Ÿ“ฑ Fully responsive design
- ๐Ÿ“Š Detailed content information
- ๐Ÿ–ผ๏ธ Screenshot gallery with lightbox
- ๐Ÿ“ˆ Download statistics integration
- ๐Ÿ”„ Auto-refresh capabilities
- ๐ŸŽฏ Customizable display settings

## Development

This project uses:
- Vite for blazing fast development
- React 18 with TypeScript
- Tailwind CSS for styling
- Zustand for state management
- PhotoSwipe for the gallery viewer

### Getting Started

```bash
# Install dependencies
npm install

# Start development server
npm run dev

# Build for production
npm run build

# Preview production build
npm run preview
```

## Configuration

The application supports various configuration options through the settings panel:

- Search precision for names and Title IDs
- Items per page
- Content display limits
- Auto-refresh intervals
- Custom data source URLs

## Contributing

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

## License

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

## Acknowledgments

- Data provided by [nlib.cc](https://nlib.cc)
- Icons by [Lucide](https://lucide.dev)
- Gallery powered by [PhotoSwipe](https://photoswipe.com)

0 comments on commit 6b3d707

Please sign in to comment.