Skip to content

Commit 2fdd60a

Browse files
committed
feat: version table for sdk, placeholder util crate
1 parent e99afd2 commit 2fdd60a

File tree

5 files changed

+57
-14
lines changed

5 files changed

+57
-14
lines changed

Cargo.toml

Lines changed: 8 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,13 @@
22
resolver = "2"
33
members = ["packages/*", "examples/*"]
44

5-
package.authors = ["Dioxus Labs", "Jonathan Kelley", "DogeDark", "marc2332", "ealmloff"]
5+
package.authors = [
6+
"Dioxus Labs",
7+
"Jonathan Kelley",
8+
"DogeDark",
9+
"marc2332",
10+
"ealmloff",
11+
]
612
package.edition = "2021"
713
package.license = "MIT OR Apache-2.0"
814
package.homepage = "https://dioxuslabs.com"
@@ -15,6 +21,7 @@ dioxus-storage = { path = "packages/storage" }
1521
dioxus-geolocation = { path = "packages/geolocation" }
1622
dioxus-notification = { path = "packages/notification" }
1723
dioxus-sync = { path = "packages/sync" }
24+
dioxus-util = { path = "packages/util" }
1825
dioxus-window = { path = "packages/window" }
1926

2027
# Dioxus
@@ -32,16 +39,3 @@ futures-util = "0.3.31"
3239
wasm-bindgen = "0.2.100"
3340
web-sys = "0.3.77"
3441
js-sys = "0.3.77"
35-
36-
# DX Profiles
37-
[profile]
38-
39-
[profile.wasm-dev]
40-
inherits = "dev"
41-
opt-level = 1
42-
43-
[profile.server-dev]
44-
inherits = "dev"
45-
46-
[profile.android-dev]
47-
inherits = "dev"

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,17 @@ You can add `dioxus-sdk` to your application by adding it to your dependencies.
8181
dioxus-sdk = { version = "0.7", features = [] }
8282
```
8383

84+
### Dioxus Compatibility
85+
This table represents the compatibility between this crate and Dioxus versions.
86+
The crate version supports a Dioxus version up until the next crate version in the table.
87+
88+
E.g. if crate version `0.1` supported Dioxus `0.6` and crate version `0.4` supported Dioxus `0.7`, crate versions `0.1`, `0.2`, and `0.3` would support Dioxus `0.6`.
89+
90+
| Crate Version | Dioxus Version |
91+
| ------------- | -------------- |
92+
| 0.6 | 0.6 |
93+
| 0.5 | 0.5 |
94+
8495
## License
8596
This project is dual licensed under the [MIT](./LICENSE-MIT) and [Apache 2.0](./LICENSE-APACHE) licenses.
8697

packages/util/Cargo.toml

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
[package]
2+
name = "dioxus-util"
3+
version = "0.1.0"
4+
5+
description = "General utilities for Dioxus apps."
6+
readme = "./README.md"
7+
keywords = ["gui", "dioxus", "hooks"]
8+
categories = ["gui", "wasm"]
9+
10+
edition.workspace = true
11+
authors.workspace = true
12+
license.workspace = true
13+
homepage.workspace = true
14+
repository.workspace = true
15+
16+
[dependencies]
17+
dioxus = { workspace = true }
18+

packages/util/README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Dioxus Util
2+
General utilities for Dioxus apps. This crate is a placeholder for now.
3+
4+
## Usage
5+
Add `dioxus-util` to your `Cargo.toml`:
6+
```toml
7+
[dependencies]
8+
dioxus-util = "0.1"
9+
```
10+
11+
### Dioxus Compatibility
12+
This table represents the compatibility between this crate and Dioxus versions.
13+
The crate version supports a Dioxus version up until the next crate version in the table.
14+
15+
E.g. if crate version `0.1` supported Dioxus `0.6` and crate version `0.4` supported Dioxus `0.7`, crate versions `0.1`, `0.2`, and `0.3` would support Dioxus `0.6`.
16+
17+
| Crate Version | Dioxus Version |
18+
| ------------- | -------------- |
19+
| 0.1 | 0.6 |

packages/util/src/lib.rs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
//! Placeholder

0 commit comments

Comments
 (0)