Skip to content
This repository was archived by the owner on Aug 20, 2024. It is now read-only.

Commit b1d91bf

Browse files
authored
Update README.md
Signed-off-by: Ryan <[email protected]>
1 parent 2072fcd commit b1d91bf

File tree

1 file changed

+42
-33
lines changed

1 file changed

+42
-33
lines changed

README.md

Lines changed: 42 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,15 @@
11
<div align="center">
2-
<a href="https://github.com/The-Winner-Games/Signs/releases"><img src="assets/type/SignsText.png" alt="Signs - A Roblox Studio Plugin" height="117"/></a>
2+
<a href="https://github.com/RyanLua/Signs/releases"><img src="assets/SignsText.png" alt="Signs - A Roblox Studio Plugin" width="350"/></a>
33
</div>
44

55
<div>&nbsp;</div>
66

77
<div align="center">
8-
<a href="https://github.com/The-Winner-Games/Signs/releases"><img alt="GitHub release (latest by date)" src="https://img.shields.io/github/v/release/The-Winner-Games/Signs"></a>
9-
<a href="https://create.roblox.com/marketplace/asset/6967799394/Signs"><img alt="GitHub all releases" src="https://img.shields.io/github/downloads/The-Winner-Games/Signs/total"></a>
10-
<a href="LICENSE.txt"><img alt="GitHub" src="https://img.shields.io/github/license/The-Winner-Games/Signs"></a>
8+
9+
[![release](https://img.shields.io/github/v/release/RyanLua/Signs)](https://github.com/RyanLua/Signs/releases)
10+
[![downloads](https://img.shields.io/github/downloads/RyanLua/Signs/total)](https://create.roblox.com/marketplace/asset/6994955669)
11+
[![license](https://img.shields.io/github/license/RyanLua/Signs)](LICENSE.txt)
12+
1113
</div>
1214

1315
---
@@ -16,75 +18,82 @@
1618
1719
## Installation
1820

21+
[![github](https://img.shields.io/badge/github-download-blue?logo=github)](https://github.com/RyanLua/Signs/releases)
22+
[![marketplace](https://img.shields.io/badge/creator%20marketplace-paid-blue?logo=roblox)](https://create.roblox.com/marketplace/asset/6994955669)
23+
[![marketplace](https://img.shields.io/badge/creator%20marketplace-free-blue?logo=roblox)](https://create.roblox.com/marketplace/asset/13085904556)
24+
1925
Signs is available on the **Creator Marketplace for 100 Robux** or from **GitHub for free**. Signs Free is available on the **Creator Marketplace for free**.
2026

21-
### Creator Marketplace <sup>(Recommended)</sup>
27+
### Creator Marketplace (Recommended)
2228

2329
Installing from the [**Creator Marketplace**](https://create.roblox.com/docs/production/publishing/creator-marketplace) is recommended to install **Signs** or **Signs Free** and allows for **automatic updates** from Roblox and **easier installation**.
2430

2531
To install from the **Creator Marketplace**, click the below link for the plugin version you want to install. Once at the page, click <kbd>**Get Plugin**</kbd > to install the plugin into **Roblox Studio**.
2632

27-
- [**Signs** (100 Robux)](https://create.roblox.com/marketplace/asset/6967799394/)
33+
- [**Signs** (100 Robux)](https://create.roblox.com/marketplace/asset/6994955669)
2834

29-
- [**Signs Free** (Free)](https://create.roblox.com/marketplace/asset/6967799394/)
35+
- [**Signs Free** (Free)](https://create.roblox.com/marketplace/asset/13085904556)
3036

3137
### GitHub
3238

3339
Installing from [**GitHub**](https://github.com/about) allows you to access the full paid version of Signs for free but **no automatic updates** due to limitations and a slightly more complex installation.
3440

3541
To install from **GitHub**, first, download the latest `.rbxm` plugin file of Signs from the below link. Once you have the file, go to `%localappdata%\Roblox\Plugins` and insert `Signs.rbxm` into that folder.
3642

37-
- [**Signs**](https://github.com/The-Winner-Games/Signs/releases)
43+
- [**Signs**](https://github.com/RyanLua/Signs/releases)
3844

3945
## Features
4046

4147
Signs offers **many features and benefits**. Not just over other plugins but TextLabels itself. Such features include:
4248

43-
<details><summary>Open-Sourced</summary>
44-
Signs is open source and free. Change and modify the plugin to meet what you want. Look out for some bugs and fix them, and we could even add your code to the official plugin. Know what you run on your computer.
45-
</details>
49+
### Open-Sourced
50+
51+
<img align="left" src="assets/thumbnails/SignsThumbnailOpenSource.png" width="100" /> Signs is open source and free. Change and modify the plugin to meet what you want. Look out for some bugs and fix them, and we could even add your code to the official plugin. Know what you run on your computer.
52+
<br/>
53+
<br/>
54+
<br/>
55+
56+
### Live Preview
4657

47-
<details><summary>Live Preview</summary>
4858
Edit signs and view changes in a preview showing exactly how your sign will look. Each and every change you make in the editor is updated to the preview. View signs before they are inserted.
49-
</details>
5059

51-
<details><summary>High Customization</summary>
60+
### High Customization
61+
5262
Edit the outline of your text, the background, and even the sign itself. Change the colors of each of these properties along with transparency. Manipulate how light interacts with your sign and if it is always rendered on top.
53-
</details>
5463

55-
<details><summary>Dark & Light Theme</summary>
64+
### Dark & Light Theme
65+
5666
The plugin's theme will automatically update when using Signs to match Roblox Studio's. No restarting of Roblox Studio or Signs is needed due to Signs being able to detect and change its theme when Roblox Studio's theme changes.
57-
</details>
5867

59-
<details><summary>Rich Text Support</summary>
68+
### Rich Text Support
69+
6070
Rich Text allows you to bold, italicize, underline, change the size, increase stroke, and many more aspects of your text from each and every letter. Use simple markup tags to change any part of your text.
61-
</details>
6271

63-
<details><summary>UI Stroke</summary>
72+
### UI Stroke
73+
6474
Change the stroke of the font in customize in ways that the text stroke property can't. Edit the outline join and thickness as well as normal text stroke properties like color and transparency.
65-
</details>
6675

67-
## Frequently Asked Questions <sup>(FAQ)</sup>
76+
## Frequently Asked Questions
6877

6978
Wasn't Signs formerly **closed-source**? Why is it **open-sourced** now?
7079

71-
> Signs was **closed-sourced** for much of its **v1.0.0** development, but starting in **v2.0.0**, Signs was changed to being **open-sourced**. Learn more at [v2.0.0](https://github.com/The-Winner-Games/Signs/releases/tag/v2.0.0).
80+
> Signs was **closed-sourced** for much of its **v1.0.0** development, but starting in **v2.0.0**, Signs was changed to being **open-sourced**. Learn more at [v2.0.0](https://github.com/RyanLua/Signs/releases/tag/v2.0.0).
7281
7382
Is Signs **harmful or malicious**? I've **found a security vulnerability**. What do I do?
7483

75-
> Signs is **completely safe** and open-sourced to allow anyone to check for potentially harmful or malicious code. Security vulnerabilities are taken seriously, **to report a security vulnerability** fill out a [draft security advisory](https://github.com/The-Winner-Games/Signs/security/advisories/new), and a collaborator will try to fix this vulnerability as fast as possible.
84+
> Signs is **completely safe** and open-sourced to allow anyone to check for potentially harmful or malicious code. Security vulnerabilities are taken seriously, **to report a security vulnerability** fill out a [draft security advisory](https://github.com/RyanLua/Signs/security/advisories/new), and a collaborator will try to fix this vulnerability as fast as possible.
7685
7786
How do I **install Signs**? What can I do if I have **issues installing**?
7887

79-
> You can **install Signs** by following the [installation steps](https://github.com/The-Winner-Games/Signs#installation). They are two currently supported ways to install Signs, either [from the Creator Marketplace](https://create.roblox.com/marketplace/asset/6967799394/) or [from GitHub](https://github.com/The-Winner-Games/Signs/releases). If you **still can't install**, open a [issue](https://github.com/The-Winner-Games/Signs/issues/new/choose) from this GitHub repository.
88+
> You can **install Signs** by following the [installation steps](https://github.com/RyanLua/Signs#installation). They are two currently supported ways to install Signs, either [from the Creator Marketplace](https://create.roblox.com/marketplace/asset/6994955669) or [from GitHub](https://github.com/RyanLua/Signs/releases). If you **still can't install**, open a [issue](https://github.com/RyanLua/Signs/issues/new/choose) from this GitHub repository.
8089
8190
Can I get **Signs for free**? What if I **can't afford Signs**?
8291

83-
> You can **get Signs for free** following the [GitHub installation steps](README.md#github). Additionally **if you want automatic updates** you can get Signs Free [from the Creator Marketplace](https://create.roblox.com/marketplace/asset/6967799394/).
92+
> You can **get Signs for free** following the [GitHub installation steps](README.md#github). Additionally **if you want automatic updates** you can get Signs Free [from the Creator Marketplace](https://create.roblox.com/marketplace/asset/13085904556).
8493
8594
I've **found a bug or want to request a feature**. How do I report it?
8695

87-
> That's great! You can **report bugs or request features** by [opening an issue](https://github.com/The-Winner-Games/Signs/issues/new/choose). Your issue will be reviewed by maintainers and considered.
96+
> That's great! You can **report bugs or request features** by [opening an issue](https://github.com/RyanLua/Signs/issues/new/choose). Your issue will be reviewed by maintainers and considered.
8897
8998
You **stole my plugin/code**. What do I do if there **copyrighted or stolen content** in this plugin?
9099

@@ -96,22 +105,22 @@ Can I **republish Signs**? What if I want to **make a plugin similar** to Signs?
96105
97106
I want to **contribute** to Signs. How can I contribute?
98107

99-
> You can **contribute** to Signs by **[forking this repository](https://github.com/The-Winner-Games/Signs/fork)** and **[making a pull request](https://github.com/The-Winner-Games/Signs/compare)**. Learn more at [Contributing](README.md#contributing).
108+
> You can **contribute** to Signs by **[forking this repository](https://github.com/RyanLua/Signs/fork)** and **[making a pull request](https://github.com/RyanLua/Signs/compare)**. Learn more at [Contributing](README.md#contributing).
100109
101110
I'm enjoying and **want to support Signs**. How can I **support Signs**?
102111

103-
> We love to hear you're enjoying Signs. You can **support Signs** by **starring this [repository](https://github.com/The-Winner-Games/Signs)** or **rating us on the [Creator Marketplace](https://create.roblox.com/marketplace/asset/6967799394/Signs)**. If you want to support us financially, you can **sponsor us on [GitHub](https://github.com/The-Winner-Games/Signs)** or **buy Signs on the [Creator Marketplace](https://create.roblox.com/marketplace/asset/6967799394/Signs)** if you haven't so already.
112+
> We love to hear you're enjoying Signs. You can **support Signs** by **starring this [repository](https://github.com/RyanLua/Signs)** or **rating us on the [Creator Marketplace](https://create.roblox.com/marketplace/asset/6994955669)**. If you want to support us financially, you can **sponsor us on [GitHub](https://github.com/RyanLua/Signs)** or **buy Signs on the [Creator Marketplace](https://create.roblox.com/marketplace/asset/6994955669)** if you haven't so already.
104113
105114
I have a **question that isn't answered** here. What do I do?
106-
> If you have a **question that isn't answered** here, you can **[start a discussion](https://github.com/The-Winner-Games/Signs/discussions/new/choose)** and ask your question. If your question is **asked frequently enough** by different people, it will be added to this FAQ.
115+
> If you have a **question that isn't answered** here, you can **[start a discussion](https://github.com/RyanLua/Signs/discussions/new/choose)** and ask your question. If your question is **asked frequently enough** by different people, it will be added to this FAQ.
107116
108117
## Contributing
109118

110-
We worked hard to make this **open-source plugin**, so please **contribute at your will**. Go ahead and [fork this repository](https://github.com/The-Winner-Games/Signs/fork), and maybe we will merge to ours someday.
119+
We worked hard to make this **open-source plugin**, so please **contribute at your will**. Go ahead and [fork this repository](https://github.com/RyanLua/Signs/fork), and maybe we will merge to ours someday.
111120

112-
If you **have a change** you want to make, please [open a new pull request](https://github.com/The-Winner-Games/Signs/compare).
121+
If you **have a contribution** you want to make, please [open a new pull request](https://github.com/RyanLua/Signs/compare).
113122

114-
If you see a **bug or want a feature**, please [open an issue](https://github.com/The-Winner-Games/Signs/issues/new/choose). Make sure to check our [Trello board](https://trello.com/b/OVQpLwYq/signs-plugin-roadmap) before you submit an issue.
123+
If you see a **bug or want a feature**, please [open an issue](https://github.com/RyanLua/Signs/issues/new/choose). Make sure to check our [Trello board](https://trello.com/b/OVQpLwYq/signs-plugin-roadmap) before you submit an issue.
115124

116125
## License
117126

0 commit comments

Comments
 (0)