Skip to content

Commit

Permalink
Update readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Fwigs committed May 12, 2023
1 parent dd406cc commit eb3bcd8
Showing 1 changed file with 234 additions and 6 deletions.
240 changes: 234 additions & 6 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,120 @@
<h1 align="center">Celestial Gaming</h1>
Celestial Gaming is a free to use, open-source, gaming site with a large collection of html5, flash, mobile, and retro games to play out of the box in your browser! WARNING: I will not take responsibility if this becomes a distraction in the classroom, nor will I take if this gets a student in trouble.
<!-- Improved compatibility of back to top link: See: https://github.com/othneildrew/Best-README-Template/pull/73 -->
<a name="readme-top"></a>
<!--
*** Thanks for checking out the Best-README-Template. If you have a suggestion
*** that would make this better, please fork the repo and create a pull request
*** or simply open an issue with the tag "enhancement".
*** Don't forget to give the project a star!
*** Thanks again! Now go create something AMAZING! :D
-->

<h1 align="center">Quick Deployments</h1>
<h1 align="center">Host On Your Own Machine</h1>


<!-- PROJECT SHIELDS -->
<!--
*** I'm using markdown "reference style" links for readability.
*** Reference links are enclosed in brackets [ ] instead of parentheses ( ).
*** See the bottom of this document for the declaration of the reference variables
*** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use.
*** https://www.markdownguide.org/basic-syntax/#reference-style-links
-->
[![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]
[![LinkedIn][linkedin-shield]][linkedin-url]



<!-- PROJECT LOGO -->
<br />
<div align="center">
<a href="https://g.shrimple.club/">
<img src="https://g.shrimple.club/imgs/favicon.ico" alt="Logo" width="150" height="150">
</a>

<h3 align="center">ShrimplePlay</h3>

<p align="center">
A multipurpose website with a website starter! :)
<br />
<a href="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/fmkash/staticdev.org"><strong>Explore the docs »</strong></a>
<br />
<br />
<a href="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/othneildrew/Best-README-Template">View Demo</a>
·
<a href="https://github.com/fmkash/staticdev.org/issues">Report Bug</a>
·
<a href="https://github.com/fmkash/staticdev.org/issues">Request Feature</a>
</p>
</div>



<!-- TABLE OF CONTENTS -->
<details>
<summary>Table of Contents</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="#acknowledgments">Acknowledgments</a></li>
</ol>
</details>



<!-- ABOUT THE PROJECT -->
## About The Project

[![Product Name Screen Shot][product-screenshot]](https://example.com)

There are many great websites that provide movies, games, social communication and more, but "STATICDEV.ORG" blows all of them out of the water. "STATICDEV.ORG" is many things such as; open source, free, reliable, embedable, and more!

Here's why:
* "STATICDEV.ORG" Focuses on the better expirience of users.
* You shouldn't be creating a multipurpose website from scratch
* "STATICDEV.ORG", is 100% free

Of course, no other website template is as easy to set up as staticdev.org! To suggest more content just open an issue!

To get started just fork the project!

<p align="right">(<a href="#readme-top" style="scroll-behavior: smooth;">back to top</a>)</p>



### Built With

This site was built using the following libraries and server backends

* [![HTML][HTML5]][static-url]
* ![JavaScript](https://img.shields.io/badge/javascript-%23323330.svg?style=for-the-badge&logo=javascript&logoColor=%23F7DF1E)
* ![CSS3](https://img.shields.io/badge/css3-%231572B6.svg?style=for-the-badge&logo=css3&logoColor=white)

<p align="right">(<a href="#readme-top" style="scroll-behavior: smooth;">back to top</a>)</p>



<!-- GETTING STARTED -->
## Getting Started
To get a local copy up and running follow these simple example steps.
```
$ git clone https://github.com/Celestial-Dev/Celestial-Gaming
$ cd Celestial-Gaming
Expand All @@ -12,5 +123,122 @@ $ npm run build
$ npm run start
```

## Want to modify and/or contribute to the project??
do `$ npm run dev` instead of `$ npm run build`
### 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

<p align="right">(<a href="#readme-top" style="scroll-behavior: smooth;">back to top</a>)</p>



<!-- 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://example.com)_

<p align="right">(<a href="#readme-top" style="scroll-behavior: smooth;">back to top</a>)</p>



<!-- ROADMAP -->
## Roadmap

-

See the [open issues](https://github.com/othneildrew/Best-README-Template/issues) for a full list of proposed features (and known issues).

<p align="right">(<a href="#readme-top" style="scroll-behavior: smooth;">back to top</a>)</p>



<!-- CONTRIBUTING -->
## Contributing

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

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!

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

<p align="right">(<a href="#readme-top" style="scroll-behavior: smooth;">back to top</a>)</p>



<!-- LICENSE -->
## License

Distributed under the GNU General Public License License. See `LICENSE` for more information.

<p align="right">(<a href="#readme-top" style="scroll-behavior: smooth;">back to top</a>)</p>



<!-- CONTACT -->
## Contact

Your Name - Discord ~ ShrimpleFix#1394 - Email ~ [email protected]

Project Link: [https://github.com/your_username/repo_name](https://github.com/your_username/repo_name)

<p align="right">(<a href="#readme-top" style="scroll-behavior: smooth;">back to top</a>)</p>



<!-- ACKNOWLEDGMENTS -->
## Acknowledgments

Use this space to list resources you find helpful and would like to give credit to. I've included a few of my favorites to kick things off!

* [Heroicons](https://heroicons.com/)
* [NextJS Template](https://replit.com/)

<p align="right">(<a href="#readme-top" style="scroll-behavior: smooth;">back to top</a>)</p>



<!-- MARKDOWN LINKS & IMAGES -->
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
[contributors-shield]: https://img.shields.io/github/contributors/fmkash/staticdev.org.svg?style=for-the-badge
[contributors-url]: https://github.com/fmkash/staticdev.org/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/fmkash/staticdev.org.svg?style=for-the-badge
[forks-url]: https://github.com/othneildrew/Best-README-Template/network/members
[stars-shield]: https://img.shields.io/github/stars/fmkash/staticdev.org.svg?style=for-the-badge
[stars-url]: https://github.com/fmkash/staticdev.org/stargazers
[issues-shield]: https://img.shields.io/github/issues/fmkash/staticdev.org.svg?style=for-the-badge
[issues-url]: https://github.com/fmkash/staticdev.org/issues
[license-shield]: https://img.shields.io/github/license/fmkash/staticdev.org.svg?style=for-the-badge
[license-url]: https://github.com/fmkash/staticdev.org/blob/master/LICENSE.txt
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
[linkedin-url]: https://linkedin.com/in/othneildrew
[product-screenshot]: images/screenshot.png
[Next.js]: https://img.shields.io/badge/next.js-000000?style=for-the-badge&logo=nextdotjs&logoColor=white
[HTML5]: https://img.shields.io/badge/html5-000000.svg?style=for-the-badge&logo=html5&logoColor=white
[JavaScript]: https://img.shields.io/badge/javascript-%23323330.svg?style=for-the-badge&logo=javascript&logoColor=%23F7DF1E
[Next-url]: https://nextjs.org/
[React.js]: https://img.shields.io/badge/React-20232A?style=for-the-badge&logo=react&logoColor=61DAFB
[React-url]: https://reactjs.org/
[Vue.js]: https://img.shields.io/badge/Vue.js-35495E?style=for-the-badge&logo=vuedotjs&logoColor=4FC08D
[static-url]: https://staticdev.org/
[Angular.io]: https://img.shields.io/badge/Angular-DD0031?style=for-the-badge&logo=angular&logoColor=white
[Angular-url]: https://angular.io/
[Svelte.dev]: https://img.shields.io/badge/Svelte-4A4A55?style=for-the-badge&logo=svelte&logoColor=FF3E00
[Svelte-url]: https://svelte.dev/
[Laravel.com]: https://img.shields.io/badge/Laravel-FF2D20?style=for-the-badge&logo=laravel&logoColor=white
[Laravel-url]: https://laravel.com
[Bootstrap.com]: https://img.shields.io/badge/Bootstrap-563D7C?style=for-the-badge&logo=bootstrap&logoColor=white
[Bootstrap-url]: https://getbootstrap.com
[JQuery.com]: https://img.shields.io/badge/jQuery-0769AD?style=for-the-badge&logo=jquery&logoColor=white
[JQuery-url]: https://jquery.com

0 comments on commit eb3bcd8

Please sign in to comment.