diff --git a/README.md b/README.md index ac234f0..71790b7 100644 --- a/README.md +++ b/README.md @@ -2,11 +2,11 @@ [![CircleCI](https://circleci.com/gh/SilverLinings89/VirusSimulator/tree/main.svg?style=svg)](https://circleci.com/gh/SilverLinings89/VirusSimulator/tree/main) -This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 13.3.5. +This is an Angular Web app with a basic implementation of the SIR Network algorithm to simulate the spread of infectious disease based on a traffic model. ## Setup -Run `npm i` to install all dependencies. +Run `pnpm i` to install all dependencies. ## Development server @@ -14,13 +14,11 @@ Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. ## Build -Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory. +Run `ng build` to build the project. The build artifacts will be stored in the `dist/VirusSimulator` directory. ## Status -The project is currently not in a released state, meaning it will not work completely and some core features are missing. A basic implementation is there however. - -I check for security updates of this codebase occasionally but don't currently have the time to invest much effort into further development. +I am working on creating a first feature complete version of this project. ## Data Sources