mirror of
https://github.com/JosunLP/UserScriptProjectTemplate.git
synced 2025-10-14 09:00:11 +00:00
feat: Update README.md with additional badges and improved formatting
This commit is contained in:
JonasPfalzgraf
parent
ec933c3545
commit
36e24a25c2
1 changed files with 49 additions and 47 deletions
96
README.md
96
README.md
|
|
@ -1,8 +1,24 @@
|
|||
# UserScript Project Template
|
||||
|
||||
[](https://github.com/JosunLP/UserScriptProjectTemplate/blob/main/LICENSE)
|
||||
[](https://github.com/JosunLP/UserScriptProjectTemplate/issues)
|
||||
[](https://github.com/JosunLP/UserScriptProjectTemplate/stargazers)
|
||||
[](https://github.com/JosunLP/UserScriptProjectTemplate/blob/main/LICENSE)
|
||||
[](https://github.com/JosunLP/UserScriptProjectTemplate/issues)
|
||||
[](https://github.com/JosunLP/UserScriptProjectTemplate/stargazers)
|
||||
[](https://github.com/JosunLP/UserScriptProjectTemplate/network)
|
||||
|
||||
[](https://www.typescriptlang.org/)
|
||||
[](https://vitejs.dev/)
|
||||
[](https://eslint.org/)
|
||||
[](https://prettier.io/)
|
||||
[](https://nodejs.org/)
|
||||
|
||||
[](https://www.tampermonkey.net/)
|
||||
[](https://www.greasespot.net/)
|
||||
[](https://violentmonkey.github.io/)
|
||||
[](https://github.com/JosunLP/UserScriptProjectTemplate#mobile-browser-support)
|
||||
|
||||
[](https://github.com/JosunLP/UserScriptProjectTemplate/commits)
|
||||
[](https://github.com/JosunLP/UserScriptProjectTemplate/graphs/contributors)
|
||||
[](https://github.com/JosunLP/UserScriptProjectTemplate)
|
||||
|
||||
## Description
|
||||
|
||||
|
|
@ -10,19 +26,19 @@ A modern, production-ready template for building UserScripts using TypeScript an
|
|||
|
||||
## Features
|
||||
|
||||
• 🚀 **Modern Tech Stack:** TypeScript, Vite, ESLint, Prettier
|
||||
• 🛡️ **Type Safety:** Strict TypeScript configuration with comprehensive UserScript API definitions
|
||||
• 🔧 **Development Tools:** ESLint, Prettier, automated build pipeline
|
||||
• 🎯 **Environment Support:** Separate development and production configurations
|
||||
• 📦 **Modular Architecture:** Component system with reusable utilities
|
||||
• 💾 **Storage Management:** Type-safe wrapper for GM_setValue/GM_getValue
|
||||
• 🛠️ **Build System:** Optimized Vite configuration with automatic header generation
|
||||
• 🎨 **DOM Utilities:** Helper functions for element manipulation and waiting
|
||||
• 🔒 **Error Handling:** Comprehensive error boundary system
|
||||
• ⚡ **Event System:** Type-safe event emitter for module communication
|
||||
• 📱 **Mobile Support:** Touch-optimized interface with mobile browser detection
|
||||
• 🤏 **Touch Gestures:** Built-in touch event handling and gesture recognition
|
||||
• 📲 **Responsive Design:** Mobile-first CSS with safe area support for notched devices
|
||||
- 🚀 **Modern Tech Stack:** TypeScript, Vite, ESLint, Prettier
|
||||
- 🛡️ **Type Safety:** Strict TypeScript configuration with comprehensive UserScript API definitions
|
||||
- 🔧 **Development Tools:** ESLint, Prettier, automated build pipeline
|
||||
- 🎯 **Environment Support:** Separate development and production configurations
|
||||
- 📦 **Modular Architecture:** Component system with reusable utilities
|
||||
- 💾 **Storage Management:** Type-safe wrapper for GM_setValue/GM_getValue
|
||||
- 🛠️ **Build System:** Optimized Vite configuration with automatic header generation
|
||||
- 🎨 **DOM Utilities:** Helper functions for element manipulation and waiting
|
||||
- 🔒 **Error Handling:** Comprehensive error boundary system
|
||||
- ⚡ **Event System:** Type-safe event emitter for module communication
|
||||
- 📱 **Mobile Support:** Touch-optimized interface with mobile browser detection
|
||||
- 🤏 **Touch Gestures:** Built-in touch event handling and gesture recognition
|
||||
- 📲 **Responsive Design:** Mobile-first CSS with safe area support for notched devices
|
||||
|
||||
## Installation
|
||||
|
||||
|
|
@ -64,9 +80,9 @@ src/
|
|||
|
||||
tools/
|
||||
├── userScriptHeader.ts # UserScript header generator
|
||||
└── userScriptHeader.js # Compiled header generator
|
||||
|
||||
assets/ # Icons and static resources
|
||||
└── icon.afdesign
|
||||
```
|
||||
|
||||
### Configuration
|
||||
|
|
@ -240,10 +256,10 @@ console.log('Portrait mode:', MobileUtils.isPortrait());
|
|||
|
||||
## UserScript Compatibility
|
||||
|
||||
• **Tampermonkey:** Full support with all GM\_\* APIs
|
||||
• **Greasemonkey:** Compatible with standard UserScript APIs
|
||||
• **Violentmonkey:** Full compatibility
|
||||
• **Safari:** Works with userscript managers
|
||||
- **Tampermonkey:** Full support with all GM\_\* APIs
|
||||
- **Greasemonkey:** Compatible with standard UserScript APIs
|
||||
- **Violentmonkey:** Full compatibility
|
||||
- **Safari:** Works with userscript managers
|
||||
|
||||
### Mobile Browser Support
|
||||
|
||||
|
|
@ -261,11 +277,11 @@ console.log('Portrait mode:', MobileUtils.isPortrait());
|
|||
|
||||
### Mobile Features
|
||||
|
||||
• **Touch Gestures:** Tap, swipe, and pinch detection
|
||||
• **Responsive Design:** Mobile-first CSS with viewport adaptation
|
||||
• **Safe Area Support:** Automatic handling of notched devices
|
||||
• **Orientation Detection:** Portrait/landscape change handling
|
||||
• **Mobile-Optimized UI:** Touch-friendly buttons and menus
|
||||
- **Touch Gestures:** Tap, swipe, and pinch detection
|
||||
- **Responsive Design:** Mobile-first CSS with viewport adaptation
|
||||
- **Safe Area Support:** Automatic handling of notched devices
|
||||
- **Orientation Detection:** Portrait/landscape change handling
|
||||
- **Mobile-Optimized UI:** Touch-friendly buttons and menus
|
||||
|
||||
## Contributing
|
||||
|
||||
|
|
@ -278,12 +294,12 @@ console.log('Portrait mode:', MobileUtils.isPortrait());
|
|||
|
||||
## Development Guidelines
|
||||
|
||||
• Follow TypeScript best practices
|
||||
• Use meaningful variable and function names
|
||||
• Add proper error handling
|
||||
• Write self-documenting code
|
||||
• Follow the established project structure
|
||||
• Run `npm run validate` before committing
|
||||
- Follow TypeScript best practices
|
||||
- Use meaningful variable and function names
|
||||
- Add proper error handling
|
||||
- Write self-documenting code
|
||||
- Follow the established project structure
|
||||
- Run `npm run validate` before committing
|
||||
|
||||
## License
|
||||
|
||||
|
|
@ -295,21 +311,7 @@ This project is licensed under the [MIT License](https://opensource.org/licenses
|
|||
|
||||
• Email: [info@josunlp.de](mailto:info@josunlp.de)
|
||||
• GitHub: [@JosunLP](https://github.com/JosunLP)
|
||||
|
||||
## Changelog
|
||||
|
||||
### v0.0.1 (Current)
|
||||
|
||||
• ✨ Modern TypeScript setup with strict type checking
|
||||
• 🛡️ Comprehensive UserScript API definitions
|
||||
• 🎨 Modular architecture with utilities and components
|
||||
• 🔧 ESLint and Prettier configuration
|
||||
• 📦 Optimized Vite build system
|
||||
• 🚀 Environment-based configuration
|
||||
• 💾 Type-safe storage management
|
||||
• 🎯 Event-driven module system
|
||||
• ⚡ DOM manipulation utilities
|
||||
• 🛠️ Automated header generation
|
||||
• Website: [josunlp.de](https://josunlp.de)
|
||||
|
||||
---
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue