Update README.md

2023-08-14 20:32:44 +00:00
parent 74fe630a94
commit 2f9d51b68c
1 changed files with 58 additions and 3 deletions
--- a/README.md
+++ b/README.md
@@ -1,5 +1,60 @@
-# TSElectronTemplate
-This is a minimalist setup to get TypeScript & Electron working. It includes nothing extra.
+<!-- Header -->
+<div id="top" align="center">
+  <br />
+  
+  <!-- Logo -->
+  <img src="https://git.zakscode.com/repo-avatars/c3df2b0fe775af37194771569752d82e54c81ba8a5493540bf14ec6bf1eadd9d" alt="Logo" width="200" height="200">
+
+  <!-- Title -->
+  ### Desktop Daemon
+  
+  <!-- Description -->
+  Virtual Desktop Pet
+
+  <!-- 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/DesktopDaemon/tags&query=$[0].name)](https://git.zakscode.com/ztimson/DesktopDaemon/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/DesktopDaemon&query=open_pr_counter)](https://git.zakscode.com/ztimson/DesktopDaemon/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/DesktopDaemon&query=open_issues_count)](https://git.zakscode.com/ztimson/DesktopDaemon/issues)
+
+</div>

 ## Table of Contents
-[[_TOC_]]
+- [Template](#top)
+  - [About](#about)
+    - [Built With](#built-with)
+  - [Setup](#setup)
+    - [Development](#development)
+  - [License](#license)
+
+## About
+
+Desktop Daemon is an experimental game to learn sprites & create customziable pets which live on your desktop. They can largly be ignored as they play along your taskbar but need attention from time to time.
+
+DD was writen completely froms scratch using TypeScript and Electron.
+
+### Built With
+[![Electron](https://img.shields.io/badge/Electron-47848F?style=for-the-badge&logo=electron&logoColor=white)](https://www.electronjs.org/)
+[![TypeScript](https://img.shields.io/badge/TypeScript-3178C6?style=for-the-badge&logo=typescript&logoColor=white)](https://typescriptlang.org/)
+
+## Setup
+
+<details>
+<summary>
+  <h3 id="development" style="display: inline">
+    Development
+  </h3>
+</summary>
+
+#### Prerequisites
+- [Node.js](https://nodejs.org/en/download)
+
+#### Instructions
+1. Install the dependencies: `npm install`
+2. Start the Angular server: `npm run start`
+
+</details>
+
+## License
+Copyright © 2023 Zakary Timson | All Rights Reserved
+
+See the [license](./LICENSE) for more information.