From 485a0774084a0d42d9bc874b559617397c276558 Mon Sep 17 00:00:00 2001
From: Cleon <18450687+meld-cp@users.noreply.github.com>
Date: Tue, 3 Jan 2023 17:27:56 +1300
Subject: [PATCH] readme

---
 README.md | 91 +++++++------------------------------------------------
 1 file changed, 11 insertions(+), 80 deletions(-)

diff --git a/README.md b/README.md
index b5e9951..d490bd0 100644
--- a/README.md
+++ b/README.md
@@ -1,88 +1,19 @@
 # Meld Build - An Obsidian Plugin
 
+## Documentaion
+
+User Guide: [docs/user-guide.md]
+
+### Examples
+
+Simple Invoice Builder: [docs/examples/invoice-builder/readme.md]
+
 ## To Do
 
--[ ] Create run log
--[ ] Show error notifications
--[ ] ability to write back data
--[ ] non-js code block bug (add non-js code block before and try to run)
--[ ] publish to github
+-[ ] better docs and examples
 -[ ] alpha release
--[ ] make parser more resilient
 -[ ] test on mobile
--[ ] add image to uri function (then inject into template)
 
+## Manually installing the plugin
 
-## API
-```js
-// Implemented
-await $.import('somefile.md');
-$.log(...anything);
-$.data.somedata.filter();
-await $.output(path, content, open);
-// To do
-$.dataview or $.dv...
-$.notes('/path').filter( n=>n.basename == 'my note');
-const output = $.templates.first().render(data);
-// logging
-// convert image (png, jpg) to data uri
-
-```
-
-## Dev info
-### First time developing plugins?
-
-Quick starting guide for new plugin devs:
-
-- Check if [someone already developed a plugin for what you want](https://obsidian.md/plugins)! There might be an existing plugin similar enough that you can partner up with.
-- Make a copy of this repo as a template with the "Use this template" button (login to GitHub if you don't see it).
-- Clone your repo to a local development folder. For convenience, you can place this folder in your `.obsidian/plugins/your-plugin-name` folder.
-- Install NodeJS, then run `npm i` in the command line under your repo folder.
-- Run `npm run dev` to compile your plugin from `main.ts` to `main.js`.
-- Make changes to `main.ts` (or create new `.ts` files). Those changes should be automatically compiled into `main.js`.
-- Reload Obsidian to load the new version of your plugin.
-- Enable plugin in settings window.
-- For updates to the Obsidian API run `npm update` in the command line under your repo folder.
-
-### Releasing new releases
-
-- Update your `manifest.json` with your new version number, such as `1.0.1`, and the minimum Obsidian version required for your latest release.
-- Update your `versions.json` file with `"new-plugin-version": "minimum-obsidian-version"` so older versions of Obsidian can download an older version of your plugin that's compatible.
-- Create new GitHub release using your new version number as the "Tag version". Use the exact version number, don't include a prefix `v`. See here for an example: https://github.com/obsidianmd/obsidian-sample-plugin/releases
-- Upload the files `manifest.json`, `main.js`, `styles.css` as binary attachments. Note: The manifest.json file must be in two places, first the root path of your repository and also in the release.
-- Publish the release.
-
-> You can simplify the version bump process by running `npm version patch`, `npm version minor` or `npm version major` after updating `minAppVersion` manually in `manifest.json`.
-> The command will bump version in `manifest.json` and `package.json`, and add the entry for the new version to `versions.json`
-
-### Adding your plugin to the community plugin list
-
-- Check https://github.com/obsidianmd/obsidian-releases/blob/master/plugin-review.md
-- Publish an initial version.
-- Make sure you have a `README.md` file in the root of your repo.
-- Make a pull request at https://github.com/obsidianmd/obsidian-releases to add your plugin.
-
-### How to use
-
-- Clone this repo.
-- `npm i` or `yarn` to install dependencies
-- `npm run dev` to start compilation in watch mode.
-
-### Manually installing the plugin
-
-- Copy over `main.js`, `styles.css`, `manifest.json` to your vault `VaultFolder/.obsidian/plugins/your-plugin-id/`.
-
-### Improve code quality with eslint (optional)
-- [ESLint](https://eslint.org/) is a tool that analyzes your code to quickly find problems. You can run ESLint against your plugin to find common bugs and ways to improve your code. 
-- To use eslint with this project, make sure to install eslint from terminal:
-  - `npm install -g eslint`
-- To use eslint to analyze this project use this command:
-  - `eslint main.ts`
-  - eslint will then create a report with suggestions for code improvement by file and line number.
-- If your source code is in a folder, such as `src`, you can use eslint with this command to analyze all files in that folder:
-  - `eslint .\src\`
-
-
-### API Documentation
-
-See https://github.com/obsidianmd/obsidian-api
+- Copy over `main.js`, `styles.css`, `manifest.json` to your vault `VaultFolder/.obsidian/plugins/meld-build/`.