From 66a98acd07f8274bf9afc86c49fd673f98a98381 Mon Sep 17 00:00:00 2001 From: Zakary Timson Date: Tue, 5 Dec 2023 03:12:20 +0000 Subject: [PATCH] Update README.md --- README.md | 142 +++++++++++++++++++++++++++--------------------------- 1 file changed, 72 insertions(+), 70 deletions(-) diff --git a/README.md b/README.md index e44828f..4a24539 100644 --- a/README.md +++ b/README.md @@ -1,70 +1,72 @@ - -
-
- - - Logo - - - ### Hacknet - - - Experimental Hacking Game - - - [![Version](https://img.shields.io/badge/dynamic/json.svg?label=Version&style=for-the-badge&url=https://git.zakscode.com/api/v1/repos/ztimson/hacknet/tags&query=$[0].name)](https://git.zakscode.com/ztimson/hacknet/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/hacknet&query=open_pr_counter)](https://git.zakscode.com/ztimson/hacknet/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/hacknet&query=open_issues_count)](https://git.zakscode.com/ztimson/hacknet/issues) - - --- - -
- Release Notes - • Report a Bug - • Request a Feature -
- - --- -
- -## Table of Contents -- [Hacknet](#top) - - [About](#about) - - [Built With](#built-with) - - [Setup](#setup) - - [Development](#development) - - [License](#license) - -## About - -Hacknet is an experimental game written in Typescript meant to provide a virtual networked environment one can hack. - -The game provides a console and it is up to users to write their own scripts using the provided API to engage with the environment. - -### Built With -[![Angular](https://img.shields.io/badge/Angular-DD0031?style=for-the-badge&logo=angular)](https://angular.io/) -[![TypeScript](https://img.shields.io/badge/TypeScript-3178C6?style=for-the-badge&logo=typescript&logoColor=white)](https://typescriptlang.org/) - -## Setup - -
- -

- Development -

-
- -#### Prerequisites -- [Node.js](https://nodejs.org/en/download) - -#### Instructions -1. Install the dependencies: `npm install` -2. Start the Angular server: `npm run start` -3. Open [http://localhost:4200](http://localhost:4200) - -
- -## License -Copyright © 2023 Zakary Timson | All Rights Reserved - -See the [license](./LICENSE) for more information. + +
+
+ + + Logo + + + ### Hacknet + + + Experimental Hacking Game + + + [![Version](https://img.shields.io/badge/dynamic/json.svg?label=Version&style=for-the-badge&url=https://git.zakscode.com/api/v1/repos/ztimson/hacknet/tags&query=$[0].name)](https://git.zakscode.com/ztimson/hacknet/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/hacknet&query=open_pr_counter)](https://git.zakscode.com/ztimson/hacknet/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/hacknet&query=open_issues_count)](https://git.zakscode.com/ztimson/hacknet/issues) + + --- + +
+ Release Notes + • Report a Bug + • Request a Feature +
+ + --- +
+ +## Table of Contents +- [Hacknet](#top) + - [About](#about) + - [Built With](#built-with) + - [Setup](#setup) + - [Development](#development) + - [License](#license) + +## About + +Hacknet is an experimental game written in Typescript meant to provide a virtual networked environment one can hack. + +This project was built using the experminatl [web konsole](https://git.zakscode.com/ztimson/konsole). + +The game provides a console and it is up to users to write their own scripts using the provided API to engage with the environment. + +### Built With +[![Angular](https://img.shields.io/badge/Angular-DD0031?style=for-the-badge&logo=angular)](https://angular.io/) +[![TypeScript](https://img.shields.io/badge/TypeScript-3178C6?style=for-the-badge&logo=typescript&logoColor=white)](https://typescriptlang.org/) + +## Setup + +
+ +

+ Development +

+
+ +#### Prerequisites +- [Node.js](https://nodejs.org/en/download) + +#### Instructions +1. Install the dependencies: `npm install` +2. Start the Angular server: `npm run start` +3. Open [http://localhost:4200](http://localhost:4200) + +
+ +## License +Copyright © 2023 Zakary Timson | All Rights Reserved + +See the [license](./LICENSE) for more information.