Usage docs, Remove template validation (#76)

* Update README with install/usage.

* Update TODO.

* Remove template validation.

* Update section on features in README.

README.md

@@ -16,8 +16,67 @@ developers who value simplicity, speed and consistent hierarchical note structur
 
 ## Install
 
-📦 The project is yet to make the `v1.0.0` release; please watch the GitHub repo (top-right) for
-future updates.
+```bash
+git clone [email protected]:revett/atlas.git
+```
+
+```
+cd atlas/
+```
+
+```
+make install-cli-locally
+```
+
+```
+echo "path: ~/notes" > ~/.atlas-notes.yml
+```
+
+## Usage
+
+All notes in Atlas must use a base type, from the following:
+
+- `area`
+- `entity`
+- `meeting`
+- `project`
+- `scratch`
+- `system`
+
+```bash
+atlas {type}
+```
+
+```bash
+atlas scratch
+```
+
+### Flags
+
+```bash
+# Before creating the new note, run the doctor command.
+atlas {type} --auto-doctor
+
+# Disable validation.
+atlas {type} --auto-doctor=false
+```
+
+```bash
+# Append a code snippet Markdown section to the note.
+atlas {type} --code-snippet
+```
+
+### Doctor
+
+```bash
+atlas doctor
+```
+
+### Shell Completion
+
+```bash
+atlas completion -h
+```
 
 ## Roadmap
 
@@ -42,18 +101,9 @@ seen as a lightweight alternative that is CLI focused.
  <img src="./assets/mid-journey-atlas-gen-conservatory.png" alt="Conservatory in a library generated by Midjourney" width="100%">
 </p>
 
-Atlas is made up of three parts, each providing different features for the user:
-
-- CLI
-- VS Code and the [Memo extension](https://github.com/svsool/memo) by
- [@svsool](https://github.com/svsool)
-- Web app
-
-### Why Use an Extension?
-
-[Svyat Sobol (@svsool)](https://github.com/svsool) has done an incredible job with the extension;
-which provides all the required core features. Therefore, it seemed logical to focus on additional
-features provided by the CLI and web app instead of duplicating effort.
+Atlas is designed to be used alongside [VS Code](https://code.visualstudio.com) and the
+[Memo extension](https://github.com/svsool/memo) by [@svsool](https://github.com/svsool). It's aim
+is to provide best-in-class features for creating, managing, and searching notes; and leaves editing notes to Svyat Sobol's [(@svsool)](https://github.com/svsool) excellent extension.
 
 ## FAQ
 

TODO.md

@@ -22,12 +22,14 @@
  - https://github.com/cosmtrek/air
 - [ ] Add command to reset IDs
 - [ ] Create `atlas init` command
-- [ ] Make templates optional in validation
+- [ ] Add validation for hanging templates
 
 # ✅ Completed
 
 > Most recent at the top.
 
+- [x] Make templates optional in validation
+- [x] Add install and usage documentation in README
 - [x] Use `path` config value when creating new notes etc
 - [x] Include configuration file with root path value that allows `atlas` to be run from anywhere
 - [x] Improve developer experience by having ephemeral knowledge base locally

internal/cmd/doctor.go

@@ -66,11 +66,6 @@ func doctorRunE(c *cobra.Command, args []string) error {
  }
  }
 
- if err := base.ValidateTemplatesExist(cfg); err != nil {
- foundError := fmt.Errorf("missing template files: %w", err)
- foundErrors = append(foundErrors, foundError)
- }
-
  log.Info().
  Int("count", len(foundErrors)).
  Msgf("detected %d validation errors", len(foundErrors))