Skip to content

Commit

Permalink
docs: updated readme, added basic usage instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
vijay-jaisankar committed Apr 24, 2022
1 parent f887261 commit e9c84e4
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,31 @@
- `python -m pip install --upgrade pip`
- `pip install trafficinterventions xml`

---
## Documentation
All relevant files can be found [here](https://github.com/WSL-IIITB/Traffic-Interventions/tree/main/docs)

---

### Sample Usage : Edge Manipulation
```py
import trafficinterventions

ce = trafficinterventions.ChangeEdges.ChangeEdges(fileName="sample.xml")

# Sample Intervention
ce.disallowAppendTypes(["bus"], ["-100"], "new_file.xml")

```
---

### Sample Usage : Lane Manipulation
```py
import trafficinterventions

cl = trafficinterventions.ChangeLanes.ChangeLanes(fileName="sample.xml")

# Sample Intervention
ce.changePriorityLanes(["highway.cycleway"], 100, "new_file.xml")

```

0 comments on commit e9c84e4

Please sign in to comment.