From 7fbea3826e932cebd6c2f9883fe6ebdf8b08d6b2 Mon Sep 17 00:00:00 2001
From: Daniel Schadt <kingdread@gmx.de>
Date: Tue, 9 Nov 2021 12:54:36 +0100
Subject: add a note about documentation to the readme

---
 README.md | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 566ba4d..a3a635c 100644
--- a/README.md
+++ b/README.md
@@ -10,12 +10,16 @@ The build process is done through `cargo`:
 cargo build --release
 ```
 
+The binary will reside in `target/release/`.
+
 Library documentation can be built through
 
 ```
-cargo doc
+cargo doc -p modderbaas
 ```
 
+Note that the crate is split into a workspace, running `cargo doc` without `-p` will give you the wrong documentation!
+
 ## Usage
 
 See `modderbaas help`.
-- 
cgit v1.2.3