docs: Add comprehensive README
This commit is contained in:
52
README.md
Normal file
52
README.md
Normal file
@@ -0,0 +1,52 @@
|
|||||||
|
# BlackRoad Zapier Integration 🔌
|
||||||
|
|
||||||
|
Connect BlackRoad to 5000+ apps with Zapier!
|
||||||
|
|
||||||
|
## Features
|
||||||
|
|
||||||
|
- **Triggers**
|
||||||
|
- New Deployment Created
|
||||||
|
- Deployment Completed
|
||||||
|
- Analytics Threshold Reached
|
||||||
|
|
||||||
|
- **Actions**
|
||||||
|
- Create Deployment
|
||||||
|
- Track Event
|
||||||
|
- Find Deployment
|
||||||
|
|
||||||
|
- **Searches**
|
||||||
|
- Find Deployment by ID
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
1. Visit [Zapier Platform](https://zapier.com/developer)
|
||||||
|
2. Create new integration
|
||||||
|
3. Import this codebase
|
||||||
|
4. Configure authentication
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
```javascript
|
||||||
|
// Zapier will handle authentication
|
||||||
|
// Configure your triggers and actions in the Zapier editor
|
||||||
|
```
|
||||||
|
|
||||||
|
## Development
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npm install
|
||||||
|
zapier test
|
||||||
|
zapier push
|
||||||
|
```
|
||||||
|
|
||||||
|
## Documentation
|
||||||
|
|
||||||
|
Full Zapier integration docs: https://zapier.com/developer/documentation/v2/
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
MIT License - See LICENSE file for details
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
Part of the **BlackRoad Empire** 🚀
|
||||||
Reference in New Issue
Block a user