aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authornea <romangraef@gmail.com>2022-08-20 03:54:06 +0200
committernea <romangraef@gmail.com>2022-08-20 03:54:06 +0200
commiteda0064aa944c2f9e7319ff5f915811df9f8fb7e (patch)
tree93b3a810feea2bb635b22a93efa9d1bf8ca11839 /README.md
parent2d9bfe1f54ec72bbdec7ef7dd7fe5ac193a31726 (diff)
downloadneurepoparsing-eda0064aa944c2f9e7319ff5f915811df9f8fb7e.tar.gz
neurepoparsing-eda0064aa944c2f9e7319ff5f915811df9f8fb7e.tar.bz2
neurepoparsing-eda0064aa944c2f9e7319ff5f915811df9f8fb7e.zip
buildscript and readme finishing
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 11 insertions, 3 deletions
diff --git a/README.md b/README.md
index 653d1c8..4f9c779 100644
--- a/README.md
+++ b/README.md
@@ -1,11 +1,19 @@
# NEU repo parsing
-A standalone library for parsing the [NEU repo](https://github.com/NotEnoughUpdates/NotEnoughUpdates-REPO/). Intended to be used for NEU, but can also be used for other purposes.
+A standalone library for parsing the [NEU repo](https://github.com/NotEnoughUpdates/NotEnoughUpdates-REPO/). Intended to
+be used for NEU, but can also be used for other purposes.
-## Licensing
+## Versioning
+
+Due to this library not having parity with the actual parser in the normal NEU mod, there will be rapid changes in
+development. As such every commit could be a breaking change. Please plan accordingly for now.
-This repository incorporates (in addition to libraries loaded by gradle) a file taken from [the google gson extra repository](https://github.com/google/gson/blob/master/extras/src/main/java/com/google/gson/typeadapters/RuntimeTypeAdapterFactory.java) with our own changes (highlighted in the code). That file is licensed under the Apache License version 2.0. The rest of the source code is licensed under the BSD-3-Clause No Military License.
+## Licensing
+This repository incorporates (in addition to libraries loaded by gradle) a file taken
+from [the google gson extra repository](https://github.com/google/gson/blob/master/extras/src/main/java/com/google/gson/typeadapters/RuntimeTypeAdapterFactory.java)
+with our own changes (highlighted in the code). That file is licensed under the Apache License version 2.0. The rest of
+the source code is licensed under the BSD-3-Clause No Military License.
```
Copyright (c) 2022 The NEU authors. All Rights Reserved.