@zumer/orbit 0.2.8 → 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (7) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +42 -34
  3. package/dist/orbit.css +1814 -34
  4. package/dist/orbit.js +2 -2
  5. package/dist/orbit.min.css +1 -1
  6. package/dist/orbit.min.js +3 -3
  7. package/package.json +3 -3
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2024 Juan Martín Muda - ZumerLab
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md CHANGED
@@ -9,7 +9,7 @@
9
9
  <b>ORBIT</b>
10
10
  </p>
11
11
  <p align="center">
12
- <b>The CSS radial UI composer.</b>
12
+ <b>Create radial interfaces using only CSS.</b>
13
13
  </p>
14
14
 
15
15
  <p align="center">
@@ -18,7 +18,7 @@
18
18
  </p>
19
19
 
20
20
  <p align="center">
21
- Get involved and leave a star. <a href="https://github.com/zumerlab/orbit/stargazers"> <img src="https://img.shields.io/github/stars/zumerlab/orbit.svg?label=%E2%98%85%20Stars&logo=-&style=social"></a>
21
+ <a href="https://github.com/zumerlab/orbit/blob/main/CONTRIBUTING.md" target="_blank"> Get involved</a> and spread the word! <a href="https://github.com/zumerlab/orbit/stargazers"> <img src="https://img.shields.io/github/stars/zumerlab/orbit.svg?label=%E2%98%85%20Stars&logo=-&style=social"></a>
22
22
 
23
23
  </p>
24
24
 
@@ -26,6 +26,9 @@
26
26
 
27
27
  **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.
28
28
 
29
+ ## Examples
30
+ Taste what can be done with Orbit by [checking out this examples](https://zumerlab.github.io/orbit-docs/examples)
31
+
29
32
  ## Status
30
33
 
31
34
  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!
@@ -39,45 +42,45 @@ This guide will help you quickly get started and install everything you need.
39
42
  To start using Orbit, include its CSS in your HTML file. You have two options:
40
43
 
41
44
  1. **Download or Import the CSS file**:
42
- - **Download**: Download the CSS file from [here](https://unpkg.com/@zumer/orbit@latest/dist/orbit.css) and link it in your HTML file:
43
- ```html
44
- <head>
45
- <link rel="stylesheet" href="path/to/orbit.css">
46
- </head>
47
- ```
48
- - **Import**: Add the following to your stylesheet:
49
- ```css
50
- @import url('path/to/orbit.css');
51
- ```
45
+ - **Download**: Download the CSS file from [here](https://unpkg.com/@zumer/orbit@latest/dist/orbit.css) and link it in your HTML file:
46
+ ```html
47
+ <head>
48
+ <link rel="stylesheet" href="path/to/orbit.css">
49
+ </head>
50
+ ```
51
+ - **Import**: Add the following to your stylesheet:
52
+ ```css
53
+ @import url('path/to/orbit.css');
54
+ ```
52
55
 
53
56
  2. **Include via CDN**:
54
- - Add this to your HTML file:
55
- ```html
56
- <head>
57
- <link rel="stylesheet" href="https://unpkg.com/@zumer/orbit@latest/dist/orbit.css">
58
- </head>
59
- ```
57
+ - Add this to your HTML file:
58
+ ```html
59
+ <head>
60
+ <link rel="stylesheet" href="https://unpkg.com/@zumer/orbit@latest/dist/orbit.css">
61
+ </head>
62
+ ```
60
63
 
61
64
  ### Step 2: Include Orbit JavaScript (Recommended)
62
65
 
63
66
  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:
64
67
 
65
68
  1. **Download the JavaScript file**:
66
- - Download from [here](https://unpkg.com/@zumer/orbit@latest/dist/orbit.js).
67
- - Link it in your HTML file:
68
- ```html
69
- <head>
70
- <script src="path/to/orbit.js" defer></script>
71
- </head>
72
- ```
69
+ - Download from [here](https://unpkg.com/@zumer/orbit@latest/dist/orbit.js).
70
+ - Link it in your HTML file:
71
+ ```html
72
+ <head>
73
+ <script src="path/to/orbit.js" defer></script>
74
+ </head>
75
+ ```
73
76
 
74
77
  2. **Include via CDN**:
75
- - Add this to your HTML file:
76
- ```html
77
- <head>
78
- <script src="https://unpkg.com/@zumer/orbit@latest/dist/orbit.js" defer></script>
79
- </head>
80
- ```
78
+ - Add this to your HTML file:
79
+ ```html
80
+ <head>
81
+ <script src="https://unpkg.com/@zumer/orbit@latest/dist/orbit.js" defer></script>
82
+ </head>
83
+ ```
81
84
 
82
85
  ### Step 3: Set up Orbit layout
83
86
 
@@ -88,8 +91,8 @@ Now, create a container with the `gravity-spot` class, and within it, add a radi
88
91
  <html lang="en">
89
92
  <head>
90
93
  <meta charset="UTF-8" />
91
- <link rel="stylesheet" href="/path/to/orbit.css" />
92
- <script src="/path/to/orbit.js" defer></script>
94
+ <link rel="stylesheet" href="https://unpkg.com/@zumer/orbit@latest/dist/orbit.css" />
95
+ <script src="https://unpkg.com/@zumer/orbit@latest/dist/orbit.js" defer></script>
93
96
  <title>Orbit Quick Start</title>
94
97
  </head>
95
98
  <body>
@@ -117,6 +120,11 @@ You can also install Orbit using npm or yarn for easier management in your proje
117
120
  npm install @zumer/orbit
118
121
  ```
119
122
 
120
- ## Next steps
123
+ ## Want to learn more about Orbit? read our documentation
121
124
 
122
125
  Check our detailed docs [here.](https://zumerlab.github.io/orbit-docs)
126
+
127
+ ## Stay in orbit
128
+
129
+ There are many way to contribute to Orbit development. Check our [guide.](https://github.com/zumerlab/orbit/blob/main/CONTRIBUTING.md)
130
+