Skip to content

Commit bd784a4

Browse files
BirjuVachhaniBirjuVachhani
committed
📝 update docs and links
1 parent 32e8c82 commit bd784a4

File tree

5 files changed

+80
-28
lines changed

5 files changed

+80
-28
lines changed

‎.github/workflows/build.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: Deploy to Firebase Hosting
1+
name: Build
22

33
on:
44
push:

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
# Box Transform
44

5-
[![melos](https://img.shields.io/badge/maintained%20with-melos-f700ff.svg?style=flat-square)](https://github.com/invertase/melos) [![Codemagic build status](https://api.codemagic.io/apps/63dd4d4ae6be1d561b8f45d2/63dd4d4ae6be1d561b8f45d1/status_badge.svg)](https://codemagic.io/apps/63dd4d4ae6be1d561b8f45d2/63dd4d4ae6be1d561b8f45d1/latest_build) [![Tests](https://github.com/hyper-designed/box_transform/workflows/Tests/badge.svg?branch=main)](https://github.com/hyper-designed/box_transform/actions) [![codecov](https://codecov.io/gh/BirjuVachhani/box_transform/branch/main/graph/badge.svg?token=SX5FXDUD7A)](https://codecov.io/gh/BirjuVachhani/box_transform)
5+
[![melos](https://img.shields.io/badge/maintained%20with-melos-f700ff.svg?style=flat-square)](https://github.com/invertase/melos) [![Build](https://github.com/hyper-designed/box_transform/actions/workflows/build.yml/badge.svg)](https://github.com/hyper-designed/box_transform/actions/workflows/build.yml) [![Tests](https://github.com/hyper-designed/box_transform/workflows/Tests/badge.svg?branch=main)](https://github.com/hyper-designed/box_transform/actions) [![codecov](https://codecov.io/gh/BirjuVachhani/box_transform/branch/main/graph/badge.svg?token=SX5FXDUD7A)](https://codecov.io/gh/BirjuVachhani/box_transform)
66

77
[Box Transform][github] provides packages that allows you to programmatically handle box resizing and dragging.
88
It provides highly flexible, programmatically resizable and draggable boxes that can be used in any Dart or Flutter

‎docs.json‎

Lines changed: 72 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,14 @@
99
"zoomImagesDefault": true,
1010
"anchors": [
1111
{
12-
"title": "Live Demo",
12+
"title": "Example App",
1313
"icon": "arrow-up-right-from-square",
14-
"link": "https://box-transform.codemagic.app"
14+
"link": "https://box-transform-example.firebaseapp.com"
15+
},
16+
{
17+
"title": "Playground",
18+
"icon": "arrow-up-right-from-square",
19+
"link": "https://box-transform-playground.firebaseapp.com"
1520
},
1621
{
1722
"title": "Report a bug",
@@ -25,31 +30,76 @@
2530
}
2631
],
2732
"sidebar": [
28-
["Overview", "/"],
29-
["Motivation", "/motivation"],
3033
[
31-
"Definitions", [
32-
["Resize Modes", "/resize_modes"]
33-
]
34+
"Overview",
35+
"/"
3436
],
3537
[
36-
"Using with Flutter", [
37-
["Getting Started", "/flutter_get_started"],
38-
["Moving", "/flutter_moving"],
39-
["Resizing", "/flutter_resizing"],
40-
["Handles", "/handles"],
41-
["Using a controller", "/flutter_controller"],
42-
["API Reference \uD83D\uDD17", "https://pub.dev/documentation/flutter_box_transform/latest/"]
43-
]
38+
"Motivation",
39+
"/motivation"
4440
],
4541
[
46-
"Using the Dart API", [
47-
["Getting Started", "/get_started"],
48-
["Moving", "/moving"],
49-
["Resizing", "/resizing"],
50-
["API Reference \uD83D\uDD17", "https://pub.dev/documentation/box_transform/latest/"]
51-
]
42+
"Definitions",
43+
[
44+
[
45+
"Resize Modes",
46+
"/resize_modes"
47+
]
48+
]
5249
],
53-
["License", "/license"]
50+
[
51+
"Using with Flutter",
52+
[
53+
[
54+
"Getting Started",
55+
"/flutter_get_started"
56+
],
57+
[
58+
"Moving",
59+
"/flutter_moving"
60+
],
61+
[
62+
"Resizing",
63+
"/flutter_resizing"
64+
],
65+
[
66+
"Handles",
67+
"/handles"
68+
],
69+
[
70+
"Using a controller",
71+
"/flutter_controller"
72+
],
73+
[
74+
"API Reference \uD83D\uDD17",
75+
"https://pub.dev/documentation/flutter_box_transform/latest/"
76+
]
77+
]
78+
],
79+
[
80+
"Using the Dart API",
81+
[
82+
[
83+
"Getting Started",
84+
"/get_started"
85+
],
86+
[
87+
"Moving",
88+
"/moving"
89+
],
90+
[
91+
"Resizing",
92+
"/resizing"
93+
],
94+
[
95+
"API Reference \uD83D\uDD17",
96+
"https://pub.dev/documentation/box_transform/latest/"
97+
]
98+
]
99+
],
100+
[
101+
"License",
102+
"/license"
103+
]
54104
]
55105
}

‎packages/box_transform/README.md‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
# Box Transform
44

5-
[![melos](https://img.shields.io/badge/maintained%20with-melos-f700ff.svg?style=flat-square)](https://github.com/invertase/melos) [![Codemagic build status](https://api.codemagic.io/apps/63dd4d4ae6be1d561b8f45d2/63dd4d4ae6be1d561b8f45d1/status_badge.svg)](https://codemagic.io/apps/63dd4d4ae6be1d561b8f45d2/63dd4d4ae6be1d561b8f45d1/latest_build) [![Tests](https://github.com/hyper-designed/box_transform/workflows/Tests/badge.svg?branch=main)](https://github.com/hyper-designed/box_transform/actions) [![Pub Version](https://img.shields.io/pub/v/box_transform?label=Pub)](https://pub.dev/packages/box_transform)
5+
[![melos](https://img.shields.io/badge/maintained%20with-melos-f700ff.svg?style=flat-square)](https://github.com/invertase/melos) [![Build](https://github.com/hyper-designed/box_transform/actions/workflows/build.yml/badge.svg)](https://github.com/hyper-designed/box_transform/actions/workflows/build.yml) [![Tests](https://github.com/hyper-designed/box_transform/workflows/Tests/badge.svg?branch=main)](https://github.com/hyper-designed/box_transform/actions) [![Pub Version](https://img.shields.io/pub/v/box_transform?label=Pub)](https://pub.dev/packages/box_transform)
66

77
[Box Transform](https://github.com/hyper-designed/box_transform) is a pure-Dart base package that allows you to
88
programmatically handle box resizing and dragging without relying on Flutter. It provides highly flexible,
@@ -24,7 +24,8 @@ programmatically resizable and draggable boxes that can be used in any Dart proj
2424
Go to the [Getting Started](https://docs.page/hyper-designed/box_transform/get_started) page of the
2525
[documentation](https://boxtransform.hyperdesigned.dev/) to start using Box Transform.
2626

27-
### Live Demo: [box-transform.codemagic.app](https://box-transform.codemagic.app)
27+
### Example App: [box-transform-example.firebaseapp.com](https://box-transform-example.firebaseapp.com)
28+
### Playground: [box-transform-playground.firebaseapp.com](https://box-transform-playground.firebaseapp.com)
2829

2930
## Documentation
3031

‎packages/flutter_box_transform/README.md‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
# Flutter Box Transform
44

5-
[![melos](https://img.shields.io/badge/maintained%20with-melos-f700ff.svg?style=flat-square)](https://github.com/invertase/melos) [![Codemagic build status](https://api.codemagic.io/apps/63dd4d4ae6be1d561b8f45d2/63dd4d4ae6be1d561b8f45d1/status_badge.svg)](https://codemagic.io/apps/63dd4d4ae6be1d561b8f45d2/63dd4d4ae6be1d561b8f45d1/latest_build) [![Pub Version](https://img.shields.io/pub/v/box_transform?label=Pub)](https://pub.dev/packages/box_transform)
5+
[![melos](https://img.shields.io/badge/maintained%20with-melos-f700ff.svg?style=flat-square)](https://github.com/invertase/melos) [![Build](https://github.com/hyper-designed/box_transform/actions/workflows/build.yml/badge.svg)](https://github.com/hyper-designed/box_transform/actions/workflows/build.yml) [![Pub Version](https://img.shields.io/pub/v/box_transform?label=Pub)](https://pub.dev/packages/box_transform)
66

77
[Flutter Box Transform](https://github.com/hyper-designed/box_transform) is a [Flutter](https://flutter.dev) package
88
that allows you to programmatically handle box resizing and dragging using Flutter widgets. It provides highly
@@ -27,7 +27,8 @@ This package uses [Box Transform](https://pub.dev/packages/box_transform) APIs i
2727
Go to the [Getting Started](https://docs.page/hyper-designed/box_transform/flutter_get_started) page of the
2828
[documentation](https://boxtransform.hyperdesigned.dev/) to start using Flutter Box Transform.
2929

30-
### Live Demo: [box-transform.codemagic.app](https://box-transform.codemagic.app)
30+
### Example App: [box-transform-example.firebaseapp.com](https://box-transform-example.firebaseapp.com)
31+
### Playground: [box-transform-playground.firebaseapp.com](https://box-transform-playground.firebaseapp.com)
3132

3233
## Documentation
3334

0 commit comments

Comments
 (0)