diff --git a/README.md b/README.md index f622bab..ce5bf73 100644 --- a/README.md +++ b/README.md @@ -26,15 +26,15 @@ **Orbit** is a CSS framework designed to create radial UI designs effortlessly. It provides intuitive CSS classes and standard web components for building radial menus, dashboards, creative portfolios, or a cutting-edge applications. -### Status +## Status We’re in the early stages of development, things are still evolving. You’re welcome to explore and experiment, but keep in mind that names, features, and functionalities may change as we refine our project. We appreciate your understanding and flexibility during this exciting phase! -### Installation & quick start +## Installation & quick start This guide will help you quickly get started and install everything you need. -#### Step 1: Include Orbit stylesheet +### Step 1: Include Orbit stylesheet To start using Orbit, include its CSS in your HTML file. You have two options: @@ -58,7 +58,7 @@ To start using Orbit, include its CSS in your HTML file. You have two options: ``` -#### Step 2: Include Orbit JavaScript (Recommended) +### Step 2: Include Orbit JavaScript (Recommended) If you plan to use additional features like radial progress bars, curved text, and slices, include Orbit's JavaScript. You can do this in two ways: @@ -79,7 +79,7 @@ If you plan to use additional features like radial progress bars, curved text, a ``` -#### Step 3: Set up Orbit layout +### Step 3: Set up Orbit layout Now, create a container with the `gravity-spot` class, and within it, add a radial layout using the `orbit` class. Inside the `orbit`, add radial elements, such us: `satellite` class or `o-text` web component . Here’s a minimal working example: @@ -109,7 +109,7 @@ Now, create a container with the `gravity-spot` class, and within it, add a radi ``` -#### Step 4: Install via Package Manager (Optional) +### Step 4: Install via Package Manager (Optional) You can also install Orbit using npm or yarn for easier management in your project: @@ -117,6 +117,6 @@ You can also install Orbit using npm or yarn for easier management in your proje npm install @zumer/orbit ``` -### Next steps +## Next steps Check our detailed docs [here.](https://zumerlab.github.io/orbit-docs)