From 17aa20a03350881082c773f373824f9000119d17 Mon Sep 17 00:00:00 2001 From: Anna Date: Sat, 31 Mar 2018 17:13:50 -0400 Subject: [PATCH] docs: update readme --- README.md | 23 +++++++++++------------ 1 file changed, 11 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index c13b737..6b43cd0 100644 --- a/README.md +++ b/README.md @@ -4,20 +4,19 @@ These are useful types when working with FFXIV. Up to date as of *patch 4.25*. -- `DataCenter` -- `World` -- `Role` -- `Job` +- `DataCenter` (feature `data_centers`) +- `World` (feature `worlds`) +- `Role` (feature `roles`) +- `Job` (feature `combat_jobs`) +- `NonCombatJob` (feature `non_combat_jobs`) +- `Classification` (feature `job_classifications`) + +`Job`, `NonCombatJob`, and `Classification` can all be simultaneously enabled with feature `jobs`. All types implement `Debug`, `Display`, `Clone`, `Copy`, and `FromStr`. +With feature `with_serde`, all types also implement `Serialize` and `Deserialize`. + They also all have a `fn as_str(&self) -> &'static str`. -They all have a `ALL` const (e.g. `Job::ALL`). - -Individual methods: - -- `Job` - - `fn role(&self) -> Role` -- `World` - - `fn data_center(&self) -> DataCenter` +With feature `all_const`, they all have an `ALL` const (e.g. `Job::ALL`).