README

API Client - Example Module

An extension to the Bristol SU Api Client for the example module
Explore the docs »

View Module · Report Bug · Request Feature

Table of Contents

• About the Module
• Getting Started
• Roadmap
• Contributing
• License
• Contact

About The Module

Connect to the example module API easily.

• Create and view files
• Comment on files

Getting Started

All you need to do to get started using this module is pull it into the API Client

composer require your-username/your-repository

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to learn, be inspired, and create. Any contributions you make are greatly appreciated.

1. Create an issue to notify us of your planned changes
2. Fork the Project
3. Create your Feature Branch (git checkout -b feature/AmazingFeature)
4. Commit your Changes (git commit -m 'Add some AmazingFeature')
5. Push to the Branch (git push origin feature/AmazingFeature)
6. Open a Pull Request to the Development Branch

See CONTRIBUTING for more information.

License

Distributed under the GPL-3.0 License. See LICENSE for more information.

Contact

Toby Twigger - toby.twigger@bristol.ac.uk

Project Link: https://github.com/your-username/your-repository