v0.1v0.1

1 files changed, 35 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..041caa1
--- /dev/null
+++ b/README.md
@@ -0,0 +1,35 @@
+# About
+
+Pager Parser is a service designed to act as a "central hub" for pager messages. Pager Parser receives pager messages, parses them, stores them and can initiate actions based on their contents.
+
+# Features
+- Flexible framework designed to receive pager messages from a variety of data sources such as [PagerMon](https://github.com/pagermon/pagermon) ([Jobyyy](https://jobyyy.net/))
+- Parsing of useful information from pager messages such as job type, paged services, etc
+- Storage of received pager messages for archival purposes
+- Storage of parsed pager message data for archival as well as generating useful metrics
+
+# Building
+
+### Pre-requisites
+
+To build the project, the .NET 7.0 SDK is required
+
+### Standalone
+
+To build the project, simply execute the following command from the project base directory:
+
+```sh
+dotnet build -c Release
+```
+
+The resulting output files may be found in the `bin/Release` directory
+
+# Deployment
+
+### Configuration
+
+To configure the project, simply edit the `appsettings.json` file, populating the desired sections
+
+### Standalone
+
+Standalone deployments of the project are current not supported in any official capacity. It is possible to run the project as a standalone deployment by registering the main executable to be started automatically and persisted in the background. This may be achieved on Linux using a systemd unit file or on Windows as an auto-start program.