Add README.md

2023-12-15 22:53:21 +00:00
parent f0fba5ee7b
commit 0fa213dbaa
1 changed files with 49 additions and 0 deletions
--- a/README.md
+++ b/README.md
@@ -0,0 +1,49 @@
+<!-- Header -->
+<div id="top" align="center">
+  <br />
+  
+  <!-- Logo -->
+  <img src="https://git.zakscode.com/repo-avatars/41876d0dc5f27daccc0a80c2cc47dfcd81d7ab23fba4180548165ac84c3c201f" alt="Logo" width="200" height="200">
+
+  <!-- Title -->
+  ### Screeps
+  
+  <!-- Description -->
+  Screeps Code
+
+  <!-- Repo badges -->
+  [![Version](https://img.shields.io/badge/dynamic/json.svg?label=Version&style=for-the-badge&url=https://git.zakscode.com/api/v1/repos/ztimson/screeps/tags&query=$[0].name)](https://git.zakscode.com/ztimson/screeps/tags)
+  [![Pull Requests](https://img.shields.io/badge/dynamic/json.svg?label=Pull%20Requests&style=for-the-badge&url=https://git.zakscode.com/api/v1/repos/ztimson/screeps&query=open_pr_counter)](https://git.zakscode.com/ztimson/screeps/pulls)
+  [![Issues](https://img.shields.io/badge/dynamic/json.svg?label=Issues&style=for-the-badge&url=https://git.zakscode.com/api/v1/repos/ztimson/screeps&query=open_issues_count)](https://git.zakscode.com/ztimson/screeps/issues)
+
+  <!-- Links -->
+
+  ---
+  <div>
+    <a href="https://git.zakscode.com/ztimson/screeps/releases" target="_blank">Release Notes</a>
+    • <a href="https://git.zakscode.com/ztimson/screeps/issues/new?template=.github%2fissue_template%2fbug.md" target="_blank">Report a Bug</a>
+    • <a href="https://git.zakscode.com/ztimson/screeps/issues/new?template=.github%2fissue_template%2fenhancement.md" target="_blank">Request a Feature</a>
+  </div>
+
+  ---
+</div>
+
+## Table of Contents
+- [Screeps](#top)
+  - [About](#about)
+    - [Built With](#built-with)
+  - [License](#license)
+
+## About
+
+[Screeps](https://screeps.com) is an MMO videgame based around coding. Using an API you have to program "screeps", workers in a 2d world, to build & manage a base. On top of gathering resources & building, the game is multiplayer so you have to deffend your base from other players & write scripts to attack others to secure more resources.
+
+For more inforation checkout https://screeps.com
+
+### Built with
+[![JavaScript](https://img.shields.io/badge/JavaScript-000000?style=for-the-badge&logo=javascript)](https://javascript.com/)
+
+## License
+Copyright © 2023 Zakary Timson | Available under MIT Licensing
+
+See the [license](./LICENSE) for more information.