Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
ImAvafe committed Jun 14, 2024
1 parent 75026ba commit d7e3cd6
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,16 +29,16 @@

### [Model 🤓](https://github.com/ImAvafe/OnyxUI/releases/latest)

## Documentation 📄

None as of yet. I'll work on Moonwave documentation in a future update. Sorry! Components are fully typed however, so props will autocomplete.

## Features ✨

- Dozens of prebuilt components 🧩
- Dozens of fully-typed prebuilt components 🧩
- Comprehensive theming system 🎨
- Ensure prop values with EnsureValue ✅
- Simplify styling UI with Modifier🖌️
- Simplify styling UI with styling props 🖌️
- Guarantee props with EnsureValue ✅

## Documentation 📄

None as of yet. I'll work on Moonwave documentation in a future update. Sorry! Components are fully typed however, so props will autocomplete.

## In alpha ⚠️

Expand All @@ -50,11 +50,11 @@ OnyxUI should provide a beautiful, simple and flexible components toolset for de

It should follow Roblox Fusion's way of doing things, while innovating upon areas as necessary.

- **Component props should be as consistent as possible**: `Color` for a `Button` should mean the same as `Color` does for a `Badge`.
- **Component props should be consistent**: `Color` for a `Button` should mean the same as `Color` does for a `Badge`.

- **Props should be inherited across components**: `Button` should support the props from `BaseButton`, `Frame` and `GuiObject`.

- **Engine-provided properties should be supported**: `Size`, `AutomaticSize`, etc are useful nearly everywhere, and should be supported nearly everywhere.
- **Engine-provided properties should be supported**: `Size`, `AutomaticSize`, etc are useful everywhere, and should be supported everywhere.

- **Theming should be both easy and comprehensive**, letting the developer choose how much, or how little they need to customize.

Expand Down

0 comments on commit d7e3cd6

Please sign in to comment.