docs: Add comprehensive README
This commit is contained in:
78
README.md
Normal file
78
README.md
Normal file
@@ -0,0 +1,78 @@
|
|||||||
|
# BlackRoad API SDKs 📦
|
||||||
|
|
||||||
|
Official SDKs for JavaScript, Python, Go, and Ruby!
|
||||||
|
|
||||||
|
## Languages
|
||||||
|
|
||||||
|
- ✅ JavaScript/TypeScript
|
||||||
|
- ✅ Python
|
||||||
|
- ✅ Go
|
||||||
|
- ✅ Ruby
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
### JavaScript/TypeScript
|
||||||
|
```bash
|
||||||
|
npm install blackroad
|
||||||
|
```
|
||||||
|
|
||||||
|
### Python
|
||||||
|
```bash
|
||||||
|
pip install blackroad
|
||||||
|
```
|
||||||
|
|
||||||
|
### Go
|
||||||
|
```bash
|
||||||
|
go get github.com/blackboxprogramming/blackroad-api-sdks/go
|
||||||
|
```
|
||||||
|
|
||||||
|
### Ruby
|
||||||
|
```bash
|
||||||
|
gem install blackroad
|
||||||
|
```
|
||||||
|
|
||||||
|
## Quick Start
|
||||||
|
|
||||||
|
### JavaScript
|
||||||
|
```javascript
|
||||||
|
const BlackRoad = require('blackroad')
|
||||||
|
const client = new BlackRoad('your-api-key')
|
||||||
|
|
||||||
|
const deployment = await client.deployments.create({
|
||||||
|
name: 'my-app',
|
||||||
|
source: 'github.com/user/repo'
|
||||||
|
})
|
||||||
|
```
|
||||||
|
|
||||||
|
### Python
|
||||||
|
```python
|
||||||
|
from blackroad import BlackRoad
|
||||||
|
|
||||||
|
client = BlackRoad('your-api-key')
|
||||||
|
deployment = client.deployments.create(
|
||||||
|
name='my-app',
|
||||||
|
source='github.com/user/repo'
|
||||||
|
)
|
||||||
|
```
|
||||||
|
|
||||||
|
### Go
|
||||||
|
```go
|
||||||
|
import "github.com/blackboxprogramming/blackroad-api-sdks/go"
|
||||||
|
|
||||||
|
client := blackroad.NewClient("your-api-key")
|
||||||
|
deployment, err := client.Deployments.Create(&blackroad.DeploymentInput{
|
||||||
|
Name: "my-app",
|
||||||
|
})
|
||||||
|
```
|
||||||
|
|
||||||
|
## Documentation
|
||||||
|
|
||||||
|
Full API docs: https://blackroad.io/docs
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
MIT License
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
Part of the **BlackRoad Empire** 🚀
|
||||||
Reference in New Issue
Block a user