From 2b76bda1da3a8e6274d01558d9d9f40661b3fd7c Mon Sep 17 00:00:00 2001 From: Aetherinox Date: Wed, 17 Jul 2024 02:18:24 -0700 Subject: [PATCH] docs: update README --- README.md | 167 +++++++++++++++++++++++++++++++----------------------- 1 file changed, 95 insertions(+), 72 deletions(-) diff --git a/README.md b/README.md index a3bf1ec..b7ab5f1 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,12 @@
-

⭕ Obsidian Script Collection ⭕

+
Dataview Snippets
+

⭕ Obsidian Snippet Collection ⭕

+
+

A collection of dataview scripts which can be utilized within your Obsidian.md notes to perform various tasks and display data.

+

@@ -10,7 +14,12 @@
-[![Version][badge-version-gh]][link-version-gh] [![Size][badge-size-gh]][badge-size-gh] [![Last Commit][badge-commit]][badge-commit] [![Contributors][badge-all-contributors]](#contributors-) +[![Version][github-version-img]][github-version-uri] +[![Build Status][github-build-img]][github-build-uri] +[![Downloads][github-downloads-img]][github-downloads-uri] +[![Size][github-size-img]][github-size-img] +[![Last Commit][github-commit-img]][github-commit-img] +[![Contributors][contribs-all-img]](#contributors-)
@@ -21,20 +30,6 @@
-## About -This repo originally started a single **Table of Contents** script which displays at the top of your obsidian note. However, numerous other scripts have been added since then. - -The snippets in this repo require you to download and install the following: -- [Obsidian.md](obsidian.md/) -- [Dataview Plugin](https://github.com/blacksmithgu/obsidian-dataview) - -
- ---- - -
- -## Table of Contents - [About](#about) - [Snippets](#snippets) - [Table of Contents: Version 1](#table-of-contents-version-1) @@ -47,11 +42,24 @@ The snippets in this repo require you to download and install the following: - [Alphabetized List: Version 1](#alphabetized-list-version-1) - [Contributors ✨](#contributors-) -

+
--- -

+
+ +## About +This repo originally started a single **Table of Contents** script which displays at the top of your obsidian note. However, numerous other scripts have been added since then. + +The snippets in this repo require you to download and install the following: +- [Obsidian.md](obsidian.md/) +- [Dataview Plugin](https://github.com/blacksmithgu/obsidian-dataview) + +
+ +--- + +
## Snippets The following snippets are available in this repo @@ -296,7 +304,7 @@ This version **requires** you to install the following:
## Contributors ✨ -We are always looking for contributors. If you feel that you can provide something useful to these Obsidian snippets, then we'd love to see your work. Before submitting your contribution, please review the following resources: +We are always looking for contributors. If you feel that you can provide something useful to Gistr, then we'd love to review your suggestion. Before submitting your contribution, please review the following resources: - [Pull Request Procedure](.github/PULL_REQUEST_TEMPLATE.md) - [Contributor Policy](CONTRIBUTING.md) @@ -310,8 +318,12 @@ Want to help but can't write code? The following people have helped get this project going: +
+ +
+ -[![Contributors][badge-all-contributors]](#contributors-) +[![Contributors][contribs-all-img]](#contributors-) @@ -320,70 +332,81 @@ The following people have helped get this project going: - +
Aetherinox
Aetherinox
💻 📆 🔍		Aetherinox
Aetherinox
💻 📆 🔍
- - - - - - - - - - - - - - - +
- - -

+ + -[link-general-npm]: https://npmjs.com -[link-general-nodejs]: https://nodejs.org -[link-npmtrends]: http://npmtrends.com/obsidian-gistr + [general-npmjs-uri]: https://npmjs.com + [general-nodejs-uri]: https://nodejs.org + [general-npmtrends-uri]: http://npmtrends.com/obsidian-dataview-snippets + -[badge-version-gh]: https://img.shields.io/github/v/tag/Aetherinox/obsidian-dataview-snippets?logo=GitHub&label=Version&color=ba5225 -[link-version-gh]: https://github.com/Aetherinox/obsidian-dataview-snippets/releases + [github-version-img]: https://img.shields.io/github/v/tag/Aetherinox/obsidian-dataview-snippets?logo=GitHub&label=Version&color=ba5225 + [github-version-uri]: https://github.com/Aetherinox/obsidian-dataview-snippets/releases + -[badge-version-npm]: https://img.shields.io/npm/v/obsidian-gistr?logo=npm&label=Version&color=ba5225 -[link-version-npm]: https://npmjs.com/package/obsidian-gistr - -[badge-license-mit]: https://img.shields.io/badge/MIT-FFF?logo=creativecommons&logoColor=FFFFFF&label=License&color=9d29a0 -[link-license-mit]: https://github.com/Aetherinox/obsidian-dataview-snippets/blob/main/LICENSE - -[badge-build]: https://img.shields.io/github/actions/workflow/status/Aetherinox/obsidian-dataview-snippets/release-npm.yml?logo=github&logoColor=FFFFFF&label=Build&color=%23278b30 -[link-build]: https://github.com/Aetherinox/obsidian-dataview-snippets/actions/workflows/release-npm.yml - -[badge-downloads-gh]: https://img.shields.io/github/downloads/Aetherinox/obsidian-dataview-snippets/total?logo=github&logoColor=FFFFFF&label=Downloads&color=376892 -[link-downloads-gh]: https://github.com/Aetherinox/obsidian-dataview-snippets/releases -[badge-downloads-npm]: https://img.shields.io/npm/dw/%40aetherinox%2Fmarked-alert-fa?logo=npm&&label=Downloads&color=376892 -[link-downloads-npm]: https://npmjs.com/package/obsidian-gistr - -[badge-size-gh]: https://img.shields.io/github/repo-size/Aetherinox/obsidian-dataview-snippets?logo=github&label=Size&color=59702a -[link-size-gh]: https://github.com/Aetherinox/obsidian-dataview-snippets/releases -[badge-size-npm]: https://img.shields.io/npm/unpacked-size/obsidian-gistr/latest?logo=npm&label=Size&color=59702a -[link-size-npm]: https://npmjs.com/package/obsidian-gistr - -[badge-coverage]: https://img.shields.io/codecov/c/github/Aetherinox/obsidian-dataview-snippets?token=MPAVASGIOG&logo=codecov&logoColor=FFFFFF&label=Coverage&color=354b9e -[link-coverage]: https://codecov.io/github/Aetherinox/obsidian-dataview-snippets + [npm-version-img]: https://img.shields.io/npm/v/obsidian-dataview-snippets?logo=npm&label=Version&color=ba5225 + [npm-version-uri]: https://npmjs.com/package/obsidian-dataview-snippets + + + [pypi-version-img]: https://img.shields.io/pypi/v/obsidian-dataview-snippets-plugin + [pypi-version-uri]: https://pypi.org/project/obsidian-dataview-snippets-plugin/ + + + [license-mit-img]: https://img.shields.io/badge/MIT-FFF?logo=creativecommons&logoColor=FFFFFF&label=License&color=9d29a0 + [license-mit-uri]: https://github.com/Aetherinox/obsidian-dataview-snippets/blob/main/LICENSE + + + [github-downloads-img]: https://img.shields.io/github/downloads/Aetherinox/obsidian-dataview-snippets/total?logo=github&logoColor=FFFFFF&label=Downloads&color=376892 + [github-downloads-uri]: https://github.com/Aetherinox/obsidian-dataview-snippets/releases + + + [npmjs-downloads-img]: https://img.shields.io/npm/dw/%40aetherinox%2Fmkdocs-link-embeds?logo=npm&&label=Downloads&color=376892 + [npmjs-downloads-uri]: https://npmjs.com/package/obsidian-dataview-snippets + + + [github-size-img]: https://img.shields.io/github/repo-size/Aetherinox/obsidian-dataview-snippets?logo=github&label=Size&color=59702a + [github-size-uri]: https://github.com/Aetherinox/obsidian-dataview-snippets/releases + + + [npmjs-size-img]: https://img.shields.io/npm/unpacked-size/obsidian-dataview-snippets/latest?logo=npm&label=Size&color=59702a + [npmjs-size-uri]: https://npmjs.com/package/obsidian-dataview-snippets + + + [codecov-coverage-img]: https://img.shields.io/codecov/c/github/Aetherinox/obsidian-dataview-snippets?token=MPAVASGIOG&logo=codecov&logoColor=FFFFFF&label=Coverage&color=354b9e + [codecov-coverage-uri]: https://codecov.io/github/Aetherinox/obsidian-dataview-snippets + -[badge-all-contributors]: https://img.shields.io/github/all-contributors/Aetherinox/obsidian-dataview-snippets?logo=contributorcovenant&color=de1f6f&label=contributors -[link-all-contributors]: https://github.com/all-contributors/all-contributors -[badge-tests]: https://img.shields.io/github/actions/workflow/status/Aetherinox/marked-alert-fa/npm-tests.yml?logo=github&label=Tests&color=2c6488 -[link-tests]: https://github.com/Aetherinox/obsidian-dataview-snippets/actions/workflows/tests.yml -[badge-commit]: https://img.shields.io/github/last-commit/Aetherinox/obsidian-dataview-snippets?logo=conventionalcommits&logoColor=FFFFFF&label=Last%20Commit&color=313131 -[link-commit]: https://github.com/Aetherinox/obsidian-dataview-snippets/commits/main/ - \ No newline at end of file + [contribs-all-img]: https://img.shields.io/github/all-contributors/Aetherinox/obsidian-dataview-snippets?logo=contributorcovenant&color=de1f6f&label=contributors + [contribs-all-uri]: https://github.com/all-contributors/all-contributors + + + [github-build-img]: https://img.shields.io/github/actions/workflow/status/Aetherinox/obsidian-dataview-snippets/release.yml?logo=github&logoColor=FFFFFF&label=Build&color=%23278b30 + [github-build-uri]: https://github.com/Aetherinox/obsidian-dataview-snippets/actions/workflows/release.yml + + + [github-build-pypi-img]: https://img.shields.io/github/actions/workflow/status/Aetherinox/obsidian-dataview-snippets/release-pypi.yml?logo=github&logoColor=FFFFFF&label=Build&color=%23278b30 + [github-build-pypi-uri]: https://github.com/Aetherinox/obsidian-dataview-snippets/actions/workflows/pypi-release.yml + + + [github-tests-img]: https://img.shields.io/github/actions/workflow/status/Aetherinox/obsidian-dataview-snippets/npm-tests.yml?logo=github&label=Tests&color=2c6488 + [github-tests-uri]: https://github.com/Aetherinox/obsidian-dataview-snippets/actions/workflows/npm-tests.yml + + + [github-commit-img]: https://img.shields.io/github/last-commit/Aetherinox/obsidian-dataview-snippets?logo=conventionalcommits&logoColor=FFFFFF&label=Last%20Commit&color=313131 + [github-commit-uri]: https://github.com/Aetherinox/obsidian-dataview-snippets/commits/main/ + + +