update makrdown and try add contributor action

This commit is contained in:
tim-hub 2023-09-05 20:44:40 +12:00
parent f3fd4e6d43
commit d30fdc13ff
3 changed files with 37 additions and 26 deletions

View file

@ -19,6 +19,12 @@ jobs:
with:
submodules: recursive
- name: Generate Sponsors 💖
uses: JamesIves/github-sponsors-readme-action@v1
with:
token: ${{ secrets.PAT }}
file: 'README.md'
- uses: pnpm/action-setup@v2.1.0
with:
version: 7.17.0

View file

@ -1,12 +1,10 @@
## About
> This plugin Bible Verse Query Functionality is currently powered by Public Bible API,
> Here is about the APIs used here, and what Bible version are supported
>
> - [Bible API and Bible Versions](docs/bible-api-and-source.md)
- [Making contributions](CONTRIBUTING.md) All kinds of Contributing is appreciated,
- maintaining the project code base,
- maintaining the project code base, (more at the section below)
- recommending the plugin to your friends and connections,
- improving the documentation,
- testing, feedback and feature requests,
- localization,
@ -15,32 +13,39 @@
- [Discussion about Obsidian Bible Reference](https://github.com/tim-hub/obsidian-bible-reference/discussions)
- This is [a discussion](https://github.com/tim-hub/obsidian-bible-reference/discussions/77) from Jeremy(@JPT62089) regarding Svelte, Localization and other features
## Contribution for Obsidian Bible Reference
All kinds of Contributing is appreciated, not only helping the project development, but also
- helping the community to use the plugin,
- improving the documentation,
- testing, feedback and feature requests,
- localization,
- and so on.
## For Coders
This project uses Typescript to provide type checking and documentation.
The repo depends on the latest plugin API (obsidian.d.ts) in Typescript Definition format, which contains TSDoc comments describing what it does.
### Development and Contribution
- Typescript/Node Development Experience + [Obsidian Plugin Development](docs/ObsidianPluginDevelopment.md)
- [Hot reload plugin](https://github.com/pjeby/hot-reload) (optional, but it isvery handy for development purpose)
- [Obsidian Bible Reference Github Project](https://github.com/tim-hub/obsidian-bible-reference/projects/1)
- There is lack of testing of the project, please help to improve it, if you have the willing
### References
### Before you start
- inspired by [obsidian emoji shorcodes](https://github.com/phibr0/obsidian-emoji-shortcodes)
- [upstream](https://github.com/obsidianmd/obsidian-sample-plugin) is template repo as obsidian sample plugin
Feel free to check out
- [Project Todo Column](https://github.com/users/tim-hub/projects/2)
- [Discussion](https://github.com/tim-hub/obsidian-bible-reference/discussions)
- [Issues](https://github.com/tim-hub/obsidian-bible-reference/issues)
- Bible Source
- [bible db sqlite](https://github.com/tim-hub/bible_databases)
- [find bible verse](https://github.com/tim-hub/FindBibleVerse) in development, this is a local node package for querying bible version
- [bible api](https://bible-api.com/) Ruby web app that serves JSON API for open and public domain bibles WEB version, Web Engilish Bible
You can probably get some ideas from there to work on,
and you can also create a new discussion or issue to discuss your ideas.
## References
### Related Projects
- [find bible verse](https://github.com/tim-hub/FindBibleVerse) in development, this is a local node package for querying bible version
- [bible name converter](https://github.com/tim-hub/biblejs-name-converter/) Bible JS Name Converter, Normalize bible references, convert them to machine readable formats, query and manipulate them
- inspiring
- inspired by [obsidian emoji shortcodes](https://github.com/phibr0/obsidian-emoji-shortcodes)
- [obsidian sample plugin](https://github.com/obsidianmd/obsidian-sample-plugin) is template repo as obsidian sample plugin
### Bible API and Bible Source
> This plugin Bible Verse Query Functionality is currently powered by Public Bible API,
> Here is about the APIs used here, and what Bible version are supported
>
> - [Bible API and Bible Versions](docs/bible-api-and-source.md)

View file

@ -6,7 +6,7 @@
[![CodeQL for Obsidain Bible Reference](https://github.com/tim-hub/obsidian-bible-reference/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/tim-hub/obsidian-bible-reference/actions/workflows/codeql-analysis.yml)
[![Build for Bible Reference Project](https://github.com/tim-hub/obsidian-bible-reference/actions/workflows/build.yml/badge.svg)](https://github.com/tim-hub/obsidian-bible-reference/actions/workflows/build.yml)
[![obsidian bible reference user discussion forum](https://img.shields.io/badge/Discussion-blue)](https://github.com/tim-hub/obsidian-bible-reference/discussions)
[![obsidain bible reference project kanban board and roadmap ](<https://img.shields.io/badge/Project(Kanban)-orange>)](https://github.com/users/tim-hub/projects/2/views/1)
[![obsidain bible reference project kanban board and roadmap ](https://img.shields.io/badge/Project(Kanban)-orange)](https://github.com/users/tim-hub/projects/2/views/1)
[![support button of obsidian bible reference](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub&color=%23fe8e86)](https://github.com/sponsors/tim-hub)
> These will be very appreciate for the project development. 👍
@ -31,8 +31,8 @@
## Contribution and Credits
- [How to Contribute](https://github.com/tim-hub/obsidian-bible-reference/blob/master/CONTRIBUTING.md)
- About [Bible API/Data Source](https://github.com/tim-hub/obsidian-bible-reference/blob/master/docs/bible-api-and-source.md)
- All different kinds of contributions are welcom, see: [How to Contribute](https://github.com/tim-hub/obsidian-bible-reference/blob/master/CONTRIBUTING.md)
- Credits: [Bible API/Data Source Providers](https://github.com/tim-hub/obsidian-bible-reference/blob/master/docs/bible-api-and-source.md)
### Sponsors and Contributors