Skip to content

Commit

Permalink
Update repo README.md - #44
Browse files Browse the repository at this point in the history
  • Loading branch information
klpanagi committed Jul 13, 2016
1 parent 655dfe1 commit 35f657e
Showing 1 changed file with 32 additions and 9 deletions.
41 changes: 32 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,18 @@

## Synopsis

The below table presents the up-to-date available RAPP Platform Service calls, throught the relevant RAPP-API (Python, JavaScript, C++)
Includes the RAPP Platform API implementations in C++, JavaScript and Python programming languages.

- [C++](https://github.com/rapp-project/rapp-api/tree/master/cpp)
- [JavaScript](https://github.com/rapp-project/rapp-api/tree/master/js)
- [Python](https://github.com/rapp-project/rapp-api/tree/master/python)

Branches and source code tags are synced to those of the [rapp-platform](https://github.com/rapp-project/rapp-platform)


## API call implemetations

The below table presents the up-to-date supported API calls for each supported programming language (Python, JavaScript, C++)

- ✓ : Implemented and tested as a part of the relevant RAPP-API.
- ✗ : Not yet implemented
Expand Down Expand Up @@ -37,28 +48,40 @@ The below table presents the up-to-date available RAPP Platform Service calls, t
| Path planning plan-path-2d ||||


Information on RAPP Platform front-end Web Services can he found [here](https://github.com/rapp-project/rapp-platform/tree/master/rapp_web_services/services).
Information on RAPP Platform Web Services can he found [here](https://github.com/rapp-project/rapp-platform/tree/master/rapp_web_services/services).


## Directories

- `cpp/` : C++ RAPP-API Sources
- `js/` : JavaScript RAPP-API Sources
- `python/` : Python RAPP-API Sources

## Tests

See under each directory for `tests`, `examples`.
## Examples/Tests

Each language API has a `README.md` with detailed instructions on how to use it.
Each API implementation has a `README.md` with detailed instructions on how to use it and a severe of written tests.

- [C++](https://github.com/rapp-project/rapp-api/tree/master/cpp)
- [JavaScript](https://github.com/rapp-project/rapp-api/tree/master/js)
- [Python](https://github.com/rapp-project/rapp-api/tree/master/python)

[![Join the chat at https://gitter.im/rapp-project/rapp-api](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/rapp-project/rapp-api?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

## Contributors

- Alexander Giokas, **[[email protected]]**
- Konstaninos Panayiotou, **[[email protected]]**
- Lazaros Penteridis, **[[email protected]]**
- Alexander Giokas, **[email protected]**
- Konstaninos Panayiotou, **[email protected]**
- Manos Tsardoulias, **[email protected]**
- Lazaros Penteridis, **[email protected]**


## Contributing

- Please read `CONTRIBUTING.md` before submitting/contributing to this project.


## Contact

An active gitter chat room is available:

[![Join the chat at https://gitter.im/rapp-project/rapp-api](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/rapp-project/rapp-api?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

0 comments on commit 35f657e

Please sign in to comment.