From 2b246df25d5ad6d1f0a64fd8c74872c1b1024888 Mon Sep 17 00:00:00 2001
From: James Grogan <8075465+jmsgrogan@users.noreply.github.com>
Date: Wed, 30 Nov 2022 11:18:18 +0000
Subject: [PATCH] Update README.md

---
 README.md | 26 ++++++++++++++++++++++----
 1 file changed, 22 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index b382d4b..b0537b9 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,28 @@
-# MediaTool
+# NotesTK
 
-This is a collection of tools and apps for working with various media (Web, Desktop Publishing, Video/Audio) on different platforms (Linux, Windows).
+Notes Toolkit (NotesTK) is a set of tools for building applications focused on taking and organising notes, like study or research materials.
 
-It tries to have low dependencies and lots of things are built from scratch.
+## Project Goals
 
-This is a personal/hobby project - things will break/change a lot.
+* Cross-platform - Currently targets Linux and Windows, Mac is planned.
+* Low dependencies - Depends on as few third-party libraries as possible.
+* Clean licensing - APIs may be similar to other libraries for compatibility but implementations are built from scratch.
+* Code re-use - If distinct areas depend on a similar routine implement it only once.
+
+## Project Status
+
+The codebase is at a very early/prototype stage and under heavy active development. It is strongly recommended to only use it as a reading reference. Expect:
+
+* No Docs or tagged releases
+* Misleadingly named and broken APIs
+* Large commits and significant breaking changes
+* Naive/low-performance implementations of things that haved worked just fine in other libraries for years
+
+The only currently recommended use case is if you are implementing some element of the library functionality, have exhasuted existing online tutorials and want to see how someone else has tackled it (bearing in mind the copyleft licensing below).
+
+## License
+
+This project is dual-licensed under the copyleft AGPL with a commercial licensing option. If using this code in your own project make sure you are aware of the implications of copyleft and AGPL. See the `LICENSE` file in this repository for more details, including contact details.
 
 # Build Dependencies