Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
Remove the disclaimer about API and add a warning instead; Add a note for developer
  • Loading branch information
xinzhel97 authored Nov 6, 2020
1 parent 2709762 commit bac3d94
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,12 @@ $ planimation.py submitPDDL [path of domain] [path of problem] [path of animatio
$ planimation.py submitVFG [path of VFG] [output format]
```

### Disclaimer
The API should be considered to be in a very alpha phase at the moment. It's not expected to handle heavy traffic and the error messages may not be complete. Until this disclaimer is removed, we **DO NOT RECOMMEND** using the API for official business (academic or otherwise).
### Note for developer
The urls in `planimation_api.py` need to be changed to the actual urls in use.
https://github.com/changyuanl/planimation-pythonAPI/blob/2709762ccd9eacf9955fbd1abab1d22419704033/planimation_api.py#L6-L8

### Warning
A malicious or careless user can easily spam requests using the python library and there is no mechanism at the server to handle such situation. Until relevant mechanism is implemented, it may not be safe to publish this python library.

### Thanks
The first version of Planimation API is developed by Changyuan Liu, Lingfeng Qiang, Mengyi Fan, Xinzhe Li and Zhaoqi Fang under Nir Lipovetzky's guidance.
Expand Down

0 comments on commit bac3d94

Please # to comment.