diff --git a/README.md b/README.md index 0676f35..6e295a9 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,167 @@ -# **An Unofficial Repl.it API** -## *Easier Interactions in a Tiny Package* - -The API.it package made by [@RayhanADev](https://repl.it/@RayhanADev) is a wrapper for Repl.it's GraphQL (and in the future REST and even Crosis) API. With multitudes of features such as: - -- **Fetching User Data** (such as): - - Profile Info (Date Joined, Profile Picture, Cycles, etc.) - - Posts by Filter - - Comments by Filter -- **Fetching Post Data** (such as): - - Title & Body - - Author - - Upvotes & Upvoters - - Comments - - Type -- **Fetching Comment Data** (such as): - - Body - - Vote Count - - Parent Comments - - Answer to Question -- **Fetching Repl Data** (such as): - - Title - - Embed Url - - Time Created - -## **How to Use?** +[![Contributors][contributors-shield]][contributors-url] +[![Forks][forks-shield]][forks-url] +[![Stargazers][stars-shield]][stars-url] +[![Issues][issues-shield]][issues-url] +[![MIT License][license-shield]][license-url] + + +
+

+ + Logo + + +

REPLAPI.it

+ +

+ A Simple and Complete Repl.it API Package +
+ Explore the docs » +
+
+ View Package on NPM + · + Report Bug + · + Request Feature +

+

+ + + + +
+

Table of Contents

+
    +
  1. + About The Project + +
  2. +
  3. + Getting Started + +
  4. +
  5. Usage
  6. +
  7. Roadmap
  8. +
  9. Contributing
  10. +
  11. License
  12. +
  13. Contact
  14. +
  15. Acknowledgements
  16. +
+
+ + + + +## About The Project + +[![Code Screenshot](images/screenshot.jpg)](https://repl.it/@RayhanADev/REPLAPIit-Replit-API-Package) + +Here's a blank template to get started: +**To avoid retyping too much info. Do a search and replace with your text editor for the following:** +`RayhanADev`, `REPLAPI.it`, `twitter_handle`, `rayhan.arayilakath@wa-students.org`, `REPLAPI.it`, `project_description` + + +### Built With + +* [NodeJS](https://github.com/nodejs/node) + + +## Getting Started + +To get a local copy up and running follow these simple steps. + +### Prerequisites + +This is an example of how to list things you need to use the software and how to install them. +* npm + ```sh + npm install npm@latest -g + ``` + +### Installation + +1. Clone the repo + ```sh + git clone https://github.com/RayhanADev/REPLAPI.it.git + ``` +2. Install NPM packages + ```sh + npm install + ``` + + + + +## Usage + +Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources. + +_For more examples, please refer to the [Documentation](https://replapidocs.rayhanadev.repl.co/)_ + + + + +## Roadmap + +See the [open issues](https://github.com/RayhanADev/REPLAPI.it/issues) for a list of proposed features (and known issues). + + + + +## Contributing + +Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**. + +1. Fork the Project +2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`) +3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`) +4. Push to the Branch (`git push origin feature/AmazingFeature`) +5. Open a Pull Request + + + + +## License + +Distributed under the GPL-3.0 License. See `LICENSE` for more information. + + + + +## Contact + +RayhanADev - [@RayhanADev](https://repl.it/@RayhanADev) - rayhan.arayilakath@wa-students.org + +Project Link: [https://github.com/RayhanADev/REPLAPI.it](https://github.com/RayhanADev/REPLAPI.it) + + + + +## Acknowledgements + +* []() +* []() +* []() + + + + + + + +[contributors-shield]: https://img.shields.io/github/contributors/RayhanADev/REPLAPI.it.svg?style=for-the-badge +[contributors-url]: https://github.com/RayhanADev/REPLAPI.it/graphs/contributors +[forks-shield]: https://img.shields.io/github/forks/RayhanADev/REPLAPI.it.svg?style=for-the-badge +[forks-url]: https://github.com/RayhanADev/REPLAPI.it/network/members +[stars-shield]: https://img.shields.io/github/stars/RayhanADev/REPLAPI.it.svg?style=for-the-badge +[stars-url]: https://github.com/RayhanADev/REPLAPI.it/stargazers +[issues-shield]: https://img.shields.io/github/issues/RayhanADev/REPLAPI.it.svg?style=for-the-badge +[issues-url]: https://github.com/RayhanADev/REPLAPI.it/issues +[license-shield]: https://img.shields.io/github/license/RayhanADev/REPLAPI.it.svg?style=for-the-badge +[license-url]: https://github.com/RayhanADev/REPLAPI.it/blob/master/LICENSE.txt diff --git a/images/logo.jpg b/images/logo.jpg new file mode 100644 index 0000000..22fe782 Binary files /dev/null and b/images/logo.jpg differ diff --git a/images/screenshot.jpg b/images/screenshot.jpg new file mode 100644 index 0000000..69830ed Binary files /dev/null and b/images/screenshot.jpg differ