Skip to content

Commit 55e4562

Browse files
chore: added repo readme
1 parent 79c94d3 commit 55e4562

File tree

1 file changed

+105
-0
lines changed

1 file changed

+105
-0
lines changed

README.md

Lines changed: 105 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
1+
# Interactions - WordPress Plugin
2+
3+
[![WordPress Plugin](https://img.shields.io/badge/WordPress-Plugin-blue.svg)](https://wordpress.org/plugins/interactions/)
4+
[![Version](https://img.shields.io/badge/version-1.3.0-green.svg)](https://wordpress.org/plugins/interactions/)
5+
[![License](https://img.shields.io/badge/license-GPL%20v2%2B-red.svg)](https://www.gnu.org/licenses/gpl-2.0.html)
6+
[![PHP](https://img.shields.io/badge/PHP-8.0%2B-purple.svg)](https://php.net/)
7+
[![WordPress](https://img.shields.io/badge/WordPress-6.6.4%2B-blue.svg)](https://wordpress.org/)
8+
9+
A WordPress plugin that adds animations, effects, and interactivity to Gutenberg blocks.
10+
11+
## 🔧 Requirements
12+
13+
- **WordPress**: 6.6.4 or higher
14+
- **PHP**: 8.0 or higher
15+
- **Node.js**: 18 or higher
16+
- **Block Editor**: Gutenberg (built-in WordPress editor)
17+
18+
## 🛠️ Development
19+
20+
### Building the Plugin
21+
```bash
22+
# Install dependencies
23+
npm install
24+
25+
# Development build (with watch mode)
26+
npm run start
27+
28+
# Production build (free version)
29+
npm run build
30+
31+
# Premium build
32+
npm run build:premium
33+
34+
# Linting
35+
npm run lint
36+
npm run lint:fix
37+
38+
# CSS linting
39+
npm run lint:css
40+
npm run lint:css:fix
41+
```
42+
43+
### Available Scripts
44+
- `npm run start` - Development build with watch mode
45+
- `npm run build` - Production build for free version
46+
- `npm run build:premium` - Production build for premium version
47+
- `npm run lint` - Run JavaScript and CSS linting
48+
- `npm run lint:js` - JavaScript linting only
49+
- `npm run lint:css` - CSS linting only
50+
- `npm run package` - Create plugin package
51+
- `npm run optimize-videos` - Optimize video assets
52+
53+
### Project Structure
54+
```
55+
src/
56+
├── action-types/ # Available action types (PHP + JS)
57+
├── interaction-types/ # Available trigger types (PHP + JS)
58+
├── admin/ # Admin interface
59+
├── editor/ # Block editor integration
60+
├── frontend/ # Frontend functionality
61+
├── locations/ # Location rules
62+
└── rest-api/ # REST API endpoints
63+
64+
dist/ # Built assets
65+
pro__premium_only/ # Premium-only features
66+
scripts/ # Build and utility scripts
67+
```
68+
69+
### Development Workflow
70+
1. Make changes to source files in `src/`
71+
2. Run `npm run start` for development with watch mode
72+
3. Test changes in WordPress admin
73+
4. Run `npm run lint` to check code quality
74+
5. Run `npm run build` for production build
75+
6. Test the built plugin
76+
77+
## 🤝 Contributing
78+
79+
1. Fork the repository
80+
2. Create a feature branch (`git checkout -b feature/amazing-feature`)
81+
3. Make your changes
82+
4. Run linting (`npm run lint`)
83+
5. Commit your changes (`git commit -m 'Add amazing feature'`)
84+
6. Push to the branch (`git push origin feature/amazing-feature`)
85+
7. Open a Pull Request
86+
87+
### Code Standards
88+
- Follow WordPress coding standards
89+
- Use ESLint and Stylelint for code quality
90+
- Write clear commit messages
91+
- Test your changes thoroughly
92+
93+
## 📄 License
94+
95+
This project is licensed under the GPL v2 or later - see the [LICENSE](LICENSE) file for details.
96+
97+
## 🔗 Links
98+
99+
- **GitHub**: [github.com/gambitph/Interactions](https://github.com/gambitph/Interactions)
100+
- **Plugin Page**: [WordPress.org](https://wordpress.org/plugins/interactions/)
101+
- **Website**: [wpinteractions.com](https://wpinteractions.com/)
102+
103+
---
104+
105+
**Made with ❤️ by [Gambit Technologies](http://gambit.ph)**

0 commit comments

Comments
 (0)