From 00f9bcf6387fcf5eb4be12dcf7122dcfe23f4095 Mon Sep 17 00:00:00 2001 From: Andras Schmelczer Date: Thu, 2 Jan 2025 15:49:37 +0000 Subject: [PATCH] Update readme --- README.md | 6 +++--- plugin/README.md | 11 ----------- 2 files changed, 3 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 200d250b..c414202a 100644 --- a/README.md +++ b/README.md @@ -19,8 +19,7 @@ - `rustup component add llvm-tools-preview` - `cargo install cargo-generate cargo-fuzz cargo-insta rustfilt cargo-binutils` - Install [`wasm-pack`](https://rustwasm.github.io/wasm-pack/installer): `curl https://rustwasm.github.io/wasm-pack/installer/init.sh -sSf | sh` -- `cargo install cargo-insta` -- `cargo install sqlx-cli` +- `cargo install cargo-insta sqlx-cli cargo-edit` ## cut new version @@ -32,7 +31,8 @@ git tag -a 0.0.2 -m "0.0.2" git push origin 0.0.2 ``` - +npm install -g openapi-typescript +openapi-typescript http://localhost:3030/api.json --output plugin/src/services/types.ts ## Todos diff --git a/plugin/README.md b/plugin/README.md index db7e58bb..d7f694da 100644 --- a/plugin/README.md +++ b/plugin/README.md @@ -57,15 +57,6 @@ Quick starting guide for new plugin devs: - 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\` ## Funding URL @@ -99,5 +90,3 @@ See https://github.com/obsidianmd/obsidian-api -npm install -g openapi-typescript -openapi-typescript http://localhost:3000/api.json --output plugin/src/services/types.ts \ No newline at end of file