Update README.md

This commit is contained in:
4Source 2024-12-02 12:04:29 +01:00 committed by GitHub
parent 55530d4563
commit ba0432996b
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -1,51 +1,8 @@
# This is a template repository
This is a template repository for [Obsidian](https://obsidian.md) plugins.
# Open Tabs Obsidian Plugin
> [!WARNING]
> This Plugin is under Development!
# Features
- Linting Setup
- Testing Setup with Jest
- Auto Version bump
- Auto Version update
This is a plugin for Obsidian (https://obsidian.md).
# Getting started
- Clone this repo.
- Make sure your NodeJS is at least v16 (node --version).
- npm i or yarn to install dependencies.
- npm run dev to start compilation in watch mode.
## Need to change
### [package.json](https://github.com/4Source/obsidian-plugin-template/blob/caf33126008642a2be32e3696f1cba34b04657fd/package.json)
- name
- description
- author
- license (optional)
### [manifest.json](https://github.com/4Source/obsidian-plugin-template/blob/caf33126008642a2be32e3696f1cba34b04657fd/manifest.json)
- id
- name
- description
- author
- authorUrl
- fundingUrl
- minAppVersion (optional)
- isDesktopOnly (optional)
### [LICENSE](https://github.com/4Source/obsidian-plugin-template/blob/caf33126008642a2be32e3696f1cba34b04657fd/LICENSE) (optional)
### [.github/workflows/cd.yml](https://github.com/4Source/obsidian-plugin-template/blob/caf33126008642a2be32e3696f1cba34b04657fd/.github/workflows/cd.yml)
versioning > Configure git
```
git config --global user.name "YOUR-USER"
git config --global user.email "YOUR-EMAIL"
```
## Need to add
### New labels
- ``major``
- ``minor``
- ``patch``
# Usage
1. Create feature branch
2. Make changes
3. Push feature branch
4. Create pull request
5. Add desired [label](#new-labels) to pull request
6. Merge pull request
7. Publish draft release
Adds a view which shows the opened groups and the tabs inside them. Allow to close groups or all tabs at once.
Example: ![image](https://github.com/user-attachments/assets/61327915-5342-4dd2-b6ce-a99363b4f8dc)