Merge pull request #7 from RayhanADev/RayhanADev-README

README v2

Author: rayhanadev

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]
+
+<!-- PROJECT LOGO -->
+<br />
+<p align="center">
+  <a href="https://github.com/RayhanADev/REPLAPI.it">
+    <img src="images/logo.jpg" alt="Logo" width="600" height="200">
+  </a>
+
+  <h3 align="center">REPLAPI.it</h3>
+
+  <p align="center">
+    A Simple and Complete Repl.it API Package
+    <br />
+    <a href="https://replapidocs.rayhanadev.repl.co"><strong>Explore the docs »</strong></a>
+    <br />
+    <br />
+    <a href="https://www.npmjs.com/package/replapi-it">View Package on NPM</a>
+    ·
+    <a href="https://github.com/RayhanADev/REPLAPI.it/issues">Report Bug</a>
+    ·
+    <a href="https://github.com/RayhanADev/REPLAPI.it/issues">Request Feature</a>
+  </p>
+</p>
+
+
+
+<!-- TABLE OF CONTENTS -->
+<details open="open">
+  <summary><h2 style="display: inline-block">Table of Contents</h2></summary>
+  <ol>
+    <li>
+      <a href="#about-the-project">About The Project</a>
+      <ul>
+        <li><a href="#built-with">Built With</a></li>
+      </ul>
+    </li>
+    <li>
+      <a href="#getting-started">Getting Started</a>
+      <ul>
+        <li><a href="#prerequisites">Prerequisites</a></li>
+        <li><a href="#installation">Installation</a></li>
+      </ul>
+    </li>
+    <li><a href="#usage">Usage</a></li>
+    <li><a href="#roadmap">Roadmap</a></li>
+    <li><a href="#contributing">Contributing</a></li>
+    <li><a href="#license">License</a></li>
+    <li><a href="#contact">Contact</a></li>
+    <li><a href="#acknowledgements">Acknowledgements</a></li>
+  </ol>
+</details>
+
+
+
+<!-- ABOUT THE PROJECT -->
+## 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 -->
+## 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 EXAMPLES -->
+## 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 -->
+## Roadmap
+
+See the [open issues](https://github.com/RayhanADev/REPLAPI.it/issues) for a list of proposed features (and known issues).
+
+
+
+<!-- CONTRIBUTING -->
+## 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 -->
+## License
+
+Distributed under the GPL-3.0 License. See `LICENSE` for more information.
+
+
+
+<!-- CONTACT -->
+## 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 -->
+## Acknowledgements
+
+* []()
+* []()
+* []()
+
+
+
+
+
+<!-- MARKDOWN LINKS & IMAGES -->
+<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
+[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