🚀 Publish 0.1.1

rster2002 · May 5, 2024 · 92fcb93 · 92fcb93
1 parent 67a8ab3
commit 92fcb93
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 2 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/ed-journals/Cargo.toml b/ed-journals/Cargo.toml
@@ -2,10 +2,11 @@
 name = "ed-journals"
 description = "Provides models for representing and parsing elite dangerous journal files"
 repository = "https://github.com/rster2002/ed-logs"
-version = "0.1.0"
+version = "0.1.1"
 edition = "2021"
 license = "MIT"
 keywords = ["elite-dangrous", "elite-journal"]
+readme = "readme.md"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 

diff --git a/ed-journals/readme.md b/ed-journals/readme.md
@@ -0,0 +1,21 @@
+# ED Journals
+
+> **Warn** this project is currently in pre-release versions, which means that it is very much work in progress. Breaking
+> changes are likely to happen.
+
+Work in progress parsing and utilities for working with journal files from Elite Dangerous, with specific emphasis on
+creating structs and enums to make working with journal entries a lot easier and predictable.
+
+## Features and plans
+
+This is a list of some of the current features and some of the features I really want to have added before a 1.0
+release.
+
+- [x] Models for journal directory and files.
+- [x] Journal reader to read entries from journal files.
+- [x] Serde models for journal entries.
+- [ ] Parsing dynamic files like `Market.json`, `Status.json` etc.
+- [ ] Async variants of models, especially the `JournalReader`.
+- [ ] Automatic journal detection based on platform etc.
+- [ ] Exobiology utilities for things like predicting available species based on planet scan etc.
+- [ ] Exploration utilities for pointing out special or unusual discoveries.