Skip to content

Commit

Permalink
Merge branch 'main' of https://github.com/1ForeverHD/TopbarPlus into …
Browse files Browse the repository at this point in the history
…main
  • Loading branch information
1ForeverHD committed May 24, 2022
2 parents f934a93 + 3c7afb7 commit 3ba1c16
Showing 1 changed file with 1 addition and 21 deletions.
22 changes: 1 addition & 21 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1 @@
![image](https://user-images.githubusercontent.com/67112172/117584922-ea8f2a00-b0cc-11eb-891b-6265f599943f.png)

<div align="center">

## 📖 [Documentation](https://1foreverhd.github.io/TopbarPlus/) | 🌊 [Playground](https://www.roblox.com/games/6199274521/TopbarPlus-Playground)

</div>

**TopbarPlus** is a module enabling the construction of dynamic topbar icons. These icons can be enhanced with features and methods, like themes, dropdowns and menus, to expand upon their appearance and behaviour.

TopbarPlus fully supports PC, Mobile, Tablet and Console, and comes with internal features such as 'overflows' to ensure icons remain within suitable bounds.

Creating an icon is as simple as:
```lua
-- Within a LocalScript in StarterPlayerScripts and assuming TopbarPlus is placed in ReplicatedStorage

local Icon = require(game:GetService("ReplicatedStorage").Icon)
local icon = Icon.new()
```

**Ready to get started?** Check out the **[docs here](https://1foreverhd.github.io/TopbarPlus/)** or see what it's like in the **[playground](https://www.roblox.com/games/6199274521/TopbarPlus-Playground)**!
https://1foreverhd.github.io/TopbarPlus/

0 comments on commit 3ba1c16

Please sign in to comment.