Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
tinchox5 authored Jul 31, 2024
1 parent 462d7e8 commit 61cedb7
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand All @@ -58,7 +58,7 @@ To start using Orbit, include its CSS in your HTML file. You have two options:
</head>
```

#### 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:

Expand All @@ -79,7 +79,7 @@ If you plan to use additional features like radial progress bars, curved text, a
</head>
```

#### 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:

Expand Down Expand Up @@ -109,14 +109,14 @@ Now, create a container with the `gravity-spot` class, and within it, add a radi
</html>
```

#### 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:

```sh
npm install @zumer/orbit
```

### Next steps
## Next steps

Check our detailed docs [here.](https://zumerlab.github.io/orbit-docs)

0 comments on commit 61cedb7

Please sign in to comment.