Skip to content

Commit bc9c863

Browse files
authored
Update README.md
1 parent fc78760 commit bc9c863

File tree

1 file changed

+46
-6
lines changed

1 file changed

+46
-6
lines changed

README.md

Lines changed: 46 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,53 @@
11
# Material Theme UI Paid Add-ons
22

3-
This is the main repository for the "Add-ons" of the Material Theme UI plugin.
3+
Welcome to the official repository for **Material Theme UI Paid Add-ons**!
4+
These add-ons extend the [Material Theme UI plugin](https://github.com/AtomMaterialUI/material-theme-issues) for JetBrains IDEs, allowing users to purchase and enable individual premium features, instead of buying the entire package.
45

5-
These addons allow users to purchases separate features of the main plugin, rather than purchase the whole package. When loaded alongside Material Theme UI, it opens the features that would be normally locked behind the paywall.
6+
## Features
67

7-
**Note: These plugins do nothing if you already purchased a Premium License for the Material Theme UI.**
8+
- **Modular Purchase:** Buy only the features you want.
9+
- **Seamless Integration:** Works alongside the main Material Theme UI plugin.
10+
- **Automatic Unlock:** If you own a Premium License for Material Theme UI, all add-ons are unlocked automatically.
811

9-
## Publish
12+
## How it Works
1013

11-
To publish new versions of the addons, simply copy from the plugins directory directly onto the root, and run publishPlugin for each plugin.
14+
1. **Purchase & Install:**
15+
Acquire your desired add-on(s) and install them via the JetBrains Marketplace or manual download.
16+
2. **Activation:**
17+
Add-ons unlock premium features when used with the main Material Theme UI plugin.
18+
3. **Premium License:**
19+
If you have a Premium License for Material Theme UI, these add-ons are unnecessary.
1220

13-
You might need to increase the version and untilBuild if necessary.
21+
## Publishing Add-ons
22+
23+
To publish new versions:
24+
1. **Copy** the plugin from the `plugins` directory to the repository root.
25+
2. **Run** `publishPlugin` for each add-on you wish to release.
26+
3. **Update** the version and `untilBuild` fields as needed.
27+
28+
## Directory Structure
29+
30+
```
31+
material-theme-ui-plugins/
32+
├── plugins/
33+
│ ├── addon-1/
34+
│ ├── addon-2/
35+
│ └── ...
36+
├── README.md
37+
└── ...
38+
```
39+
40+
## Contributing
41+
42+
We welcome contributions!
43+
To submit bug reports, feature requests, or pull requests, please use the [GitHub Issues](https://github.com/AtomMaterialUI/material-theme-ui-plugins/issues) and [Pull Requests](https://github.com/AtomMaterialUI/material-theme-ui-plugins/pulls) section.
44+
45+
## License
46+
47+
See each add-on's directory for specific license information.
48+
49+
---
50+
51+
**Note:**
52+
These add-ons require the [Material Theme UI plugin](https://github.com/Chrisrm/material-theme-jetbrains) to function.
53+
If you already purchased a Premium License for Material Theme UI, you do not need to buy these add-ons separately.

0 commit comments

Comments
 (0)