docs: add README.md

also format with `cargo fmt`

Author: vhyrro

README.md

@@ -0,0 +1,16 @@
+# A Directory Manager for [Neorg](https://github.com/nvim-neorg/neorg)
+
+The `neorg-dirman` crate is a core module which provides a basic interface for workspaces.
+
+Workspaces are the backbone of [Neorg](https://github.com/nvim-neorg/neorg) - they are
+a directory with an assigned name whose files are `.norg` notes belonging to a specific
+area of focus.
+
+This crate exposes a
+[`Workspace`](https://docs.rs/neorg-dirman/latest/neorg_dirman/workspace/struct.Workspace.html)
+struct as well as a
+[`WorkspaceManager`](https://docs.rs/neorg-dirman/latest/neorg_dirman/workspace/struct.WorkspaceManager.html)
+to easily keep track of many workspaces as well as the current ("active")
+workspace. A
+[`files()`](https://docs.rs/neorg-dirman/latest/neorg_dirman/workspace/struct.Workspace.html#method.files)
+function is also provided to enumerate all files within a given workspace.

src/workspace.rs

@@ -132,9 +132,16 @@ mod tests {
             path: "~/another/path".into(),
         };
 
-        let mut workspace_manager = WorkspaceManager::new(vec![&workspace1, &workspace2], &workspace1.name).expect("Workspace 1 not found!");
-        workspace_manager.set_current_workspace(&workspace2.name).expect("Unable to set the current workspace");
-
-        assert_eq!(&workspace_manager.get_current_workspace().name, &workspace2.name);
+        let mut workspace_manager =
+            WorkspaceManager::new(vec![&workspace1, &workspace2], &workspace1.name)
+                .expect("Workspace 1 not found!");
+        workspace_manager
+            .set_current_workspace(&workspace2.name)
+            .expect("Unable to set the current workspace");
+
+        assert_eq!(
+            &workspace_manager.get_current_workspace().name,
+            &workspace2.name
+        );
     }
 }