SDK Rename (#31)

* revision: readme * revision: readme warning * revision: note readme * revision: update date * revision: notice * revision: rename to sdk * revision: description * revision: geolocation example readme * revision: title
DioxusLabs · Apr 5, 2024 · bde83a2 · bde83a2
1 parent d83fd9d
commit bde83a2
Show file tree

Hide file tree

Showing 45 changed files with 53 additions and 52 deletions.
diff --git a/.github/workflows/rust.yml b/.github/workflows/rust.yml
@@ -32,5 +32,5 @@ jobs:
       - run: rustup target add wasm32-unknown-unknown
       - run: rustup component add clippy
       - uses: actions/checkout@v3
-      - run: cargo clippy --package dioxus-std --target wasm32-unknown-unknown --tests --features wasm-testing -- -D warnings
-      - run: cargo clippy --package dioxus-std --tests --features desktop-testing -- -D warnings
+      - run: cargo clippy --package dioxus-sdk --target wasm32-unknown-unknown --tests --features wasm-testing -- -D warnings
+      - run: cargo clippy --package dioxus-sdk --tests --features desktop-testing -- -D warnings
diff --git a/.github/workflows/testing.yml b/.github/workflows/testing.yml
@@ -19,7 +19,7 @@ jobs:
     - uses: actions/checkout@v3
     - run: rustup target add wasm32-unknown-unknown
     - uses: Swatinem/rust-cache@v2
-    - run: cargo build --package dioxus-std --verbose --target wasm32-unknown-unknown --no-default-features --features wasm-testing
+    - run: cargo build --package dioxus-sdk --verbose --target wasm32-unknown-unknown --no-default-features --features wasm-testing
     # need to run tests here
 
   desktop:
@@ -29,5 +29,5 @@ jobs:
     steps:
     - uses: actions/checkout@v3
     - uses: Swatinem/rust-cache@v2
-    - run: cargo build --package dioxus-std --verbose --no-default-features --features desktop-testing
-    - run: cargo test --package dioxus-std --verbose --no-default-features --features desktop-testing
+    - run: cargo build --package dioxus-sdk --verbose --no-default-features --features desktop-testing
+    - run: cargo test --package dioxus-sdk --verbose --no-default-features --features desktop-testing
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,10 +1,9 @@
-[workspace]
-resolver = "2"
-members = [
-    "std",
-    "examples/*",
-]
-
-[workspace.dependencies]
-dioxus-std = { path = "./std" }
-dioxus = { version = "0.5" }
+[workspace]
+resolver = "2"
+members = ["sdk", "examples/*"]
+
+[workspace.dependencies]
+dioxus-sdk = { path = "./sdk" }
+dioxus = { version = "0.5" }
+dioxus-web = { version = "0.5" }
+dioxus-desktop = { version = "0.5" }
diff --git a/README.md b/README.md
@@ -5,23 +5,23 @@
 <br/>
 
 <div align="center">
-  <h1>🧰 Dioxus Standard Library 🚀</h1>
+  <h1>🧰 Dioxus Development Kit 🚀</h1>
   <p><strong>A platform agnostic library for supercharging your productivity with Dioxus.</strong></p>
 </div>
 
 <div align="center">
   <!-- Crates version -->
-  <a href="https://crates.io/crates/dioxus-std">
-    <img src="https://img.shields.io/crates/v/dioxus-std.svg?style=flat-square"
+  <a href="https://crates.io/crates/dioxus-sdk">
+    <img src="https://img.shields.io/crates/v/dioxus-sdk.svg?style=flat-square"
     alt="Crates.io version" />
   </a>
   <!-- Downloads -->
-  <a href="https://crates.io/crates/dioxus-std">
-    <img src="https://img.shields.io/crates/d/dioxus-std.svg?style=flat-square"
+  <a href="https://crates.io/crates/dioxus-sdk">
+    <img src="https://img.shields.io/crates/d/dioxus-sdk.svg?style=flat-square"
       alt="Download" />
   </a>
   <!-- docs -->
-  <a href="https://docs.rs/dioxus-std">
+  <a href="https://docs.rs/dioxus-sdk">
     <img src="https://img.shields.io/badge/docs-latest-blue.svg?style=flat-square"
       alt="docs.rs docs" />
   </a>
@@ -32,7 +32,7 @@
 <p align="center"><i>This library is still under development. Expect breaking changes!</i></p>
 <br/>
 
-`dioxus-std` is a Dioxus standard library that provides abstractions for your Dioxus app. Abstractions included are notifications, clipboard, geolocation and storage with more to come!
+`dioxus-sdk` is a development kit for Dioxus that provides abstractions for your Dioxus app. Abstractions included are notifications, clipboard, geolocation and storage with more to come!
 
 **Features**
 - [x] Geolocation - (Web, Windows)
@@ -51,7 +51,7 @@
 Geolocation example:
 
 ```rust
-use dioxus_std::geolocation::{
+use dioxus_sdk::geolocation::{
     init_geolocator, use_geolocation, PowerMode
 };
 
@@ -82,15 +82,15 @@ sudo apt-get install xorg-dev
 ```
 
 ## Usage
-You can add `dioxus-std` to your application by adding it to your dependencies.
+You can add `dioxus-sdk` to your application by adding it to your dependencies.
 ```toml
 [dependencies]
-dioxus-std =  { version = "0.5", features = [] }
+dioxus-sdk=  { version = "0.5", features = [] }
 ```
 
 ## License
 This project is licensed under the [MIT license].
 
 [mit license]: ./LICENSE
 
-Every contribution intentionally submitted for inclusion in `dioxus-std` by you, shall be licensed as MIT, without any additional terms or conditions.
+Every contribution intentionally submitted for inclusion in `dioxus-sdk` by you, shall be licensed as MIT, without any additional terms or conditions.
diff --git a/examples/channel/Cargo.toml b/examples/channel/Cargo.toml
@@ -4,8 +4,9 @@ version = "0.1.0"
 edition = "2021"
 
 [dependencies]
-dioxus-std = { workspace = true, features = ["utils"]}
-dioxus = { workspace = true, features = ["web"]}
+dioxus-sdk = { workspace = true, features = ["utils"] }
+dioxus = { workspace = true, features = ["web"] }
+
 
 log = "0.4.6"
 

diff --git a/examples/channel/src/main.rs b/examples/channel/src/main.rs
@@ -1,5 +1,5 @@
 use dioxus::prelude::*;
-use dioxus_std::utils::channel::{use_channel, use_listen_channel};
+use dioxus_sdk::utils::channel::{use_channel, use_listen_channel};
 
 fn main() {
     // init debug tool for WebAssembly

diff --git a/examples/clipboard/Cargo.toml b/examples/clipboard/Cargo.toml
@@ -4,5 +4,5 @@ version = "0.1.0"
 edition = "2021"
 
 [dependencies]
-dioxus-std = { workspace = true, features = ["clipboard"] }
-dioxus = { workspace = true, features = ["desktop"]}
+dioxus-sdk = { workspace = true, features = ["clipboard"] }
+dioxus = { workspace = true, features = ["desktop"] }
diff --git a/examples/clipboard/src/main.rs b/examples/clipboard/src/main.rs
@@ -1,5 +1,5 @@
 use dioxus::prelude::*;
-use dioxus_std::clipboard::use_clipboard;
+use dioxus_sdk::clipboard::use_clipboard;
 
 fn main() {
     launch(app);

diff --git a/examples/color_scheme/Cargo.toml b/examples/color_scheme/Cargo.toml
@@ -4,7 +4,7 @@ version = "0.1.0"
 edition = "2021"
 
 [dependencies]
-dioxus-std = { workspace = true, features = ["color_scheme"] }
+dioxus-sdk = { workspace = true, features = ["color_scheme"] }
 dioxus = { workspace = true, features = ["web"]}
 
 log = "0.4.6"

diff --git a/examples/color_scheme/src/main.rs b/examples/color_scheme/src/main.rs
@@ -1,5 +1,5 @@
 use dioxus::prelude::*;
-use dioxus_std::color_scheme::use_preferred_color_scheme;
+use dioxus_sdk::color_scheme::use_preferred_color_scheme;
 
 fn main() {
     // init debug tool for WebAssembly

diff --git a/examples/geolocation/Cargo.toml b/examples/geolocation/Cargo.toml
@@ -4,6 +4,7 @@ version = "0.1.0"
 edition = "2021"
 
 [dependencies]
-dioxus-std = { workspace = true, features = ["geolocation"] }
+dioxus-sdk = { workspace = true, features = ["geolocation"] }
 # You can change from 'desktop' to 'web' as well
 dioxus = { workspace = true, features = ["desktop"] } 
+
diff --git a/examples/geolocation/README.md b/examples/geolocation/README.md
@@ -4,4 +4,4 @@ Learn how to use the `geolocation` abstraction.
 
 Run:
 
-```cargo run```
+```dx serve```
diff --git a/examples/geolocation/src/main.rs b/examples/geolocation/src/main.rs
@@ -1,5 +1,5 @@
 use dioxus::prelude::*;
-use dioxus_std::geolocation::{init_geolocator, use_geolocation, PowerMode};
+use dioxus_sdk::geolocation::{init_geolocator, use_geolocation, PowerMode};
 
 fn main() {
     launch(app);

diff --git a/examples/i18n/Cargo.toml b/examples/i18n/Cargo.toml
@@ -4,7 +4,7 @@ version = "0.1.0"
 edition = "2021"
 
 [dependencies]
-dioxus-std = { workspace = true, features = ["i18n"] }
+dioxus-sdk = { workspace = true, features = ["i18n"] }
 dioxus = { workspace = true, features = ["web"] }
 
 log = "0.4.6"

diff --git a/examples/i18n/src/main.rs b/examples/i18n/src/main.rs
@@ -1,6 +1,6 @@
 use dioxus::prelude::*;
-use dioxus_std::i18n::*;
-use dioxus_std::translate;
+use dioxus_sdk::i18n::*;
+use dioxus_sdk::translate;
 use std::str::FromStr;
 
 fn main() {

diff --git a/examples/storage/Cargo.toml b/examples/storage/Cargo.toml
@@ -4,7 +4,7 @@ version = "0.1.0"
 edition = "2021"
 
 [dependencies]
-dioxus-std = { workspace = true, features = ["storage"] }
+dioxus-sdk = { workspace = true, features = ["storage"] }
 dioxus = { workspace = true, features = ["router"] }
 
 [features]

diff --git a/examples/storage/src/main.rs b/examples/storage/src/main.rs
@@ -1,9 +1,9 @@
 use dioxus::prelude::*;
 use dioxus_router::prelude::*;
-use dioxus_std::storage::*;
+use dioxus_sdk::storage::*;
 
 fn main() {
-    dioxus_std::storage::set_dir!();
+    dioxus_sdk::storage::set_dir!();
     launch(app);
 }
 

diff --git a/std/Cargo.toml → sdk/Cargo.toml b/std/Cargo.toml → sdk/Cargo.toml
@@ -1,12 +1,12 @@
 [package]
-name = "dioxus-std"
+name = "dioxus-sdk"
 version = "0.5.0"
 authors = ["Jonathan Kelley", "Dioxus Labs", "ealmloff", "DogeDark", "marc2332"]
 edition = "2021"
 description = "Platform agnostic library for supercharging your productivity with Dioxus"
 license = "MIT"
 readme = "../README.md"
-repository = "https://github.com/DioxusLabs/dioxus-std/"
+repository = "https://github.com/DioxusLabs/dioxus-sdk/"
 homepage = "https://dioxuslabs.com"
 keywords = ["dom", "gui", "dioxus", "standard", "hooks"]
 categories = ["multimedia", "os", "wasm"]

diff --git a/std/src/clipboard/mod.rs → sdk/src/clipboard/mod.rs b/std/src/clipboard/mod.rs → sdk/src/clipboard/mod.rs
diff --git a/std/src/clipboard/use_clipboard.rs → sdk/src/clipboard/use_clipboard.rs b/std/src/clipboard/use_clipboard.rs → sdk/src/clipboard/use_clipboard.rs
@@ -43,7 +43,7 @@ impl UseClipboard {
 /// # Examples
 ///
 /// ```ignore
-/// use dioxus_std::clipboard::use_clipboard;
+/// use dioxus_sdk::clipboard::use_clipboard;
 ///
 /// // Get a handle to the clipboard
 /// let mut clipboard = use_clipboard();

diff --git a/std/src/color_scheme/mod.rs → sdk/src/color_scheme/mod.rs b/std/src/color_scheme/mod.rs → sdk/src/color_scheme/mod.rs
diff --git a/...olor_scheme/use_preferred_color_scheme.rs → ...olor_scheme/use_preferred_color_scheme.rs b/...olor_scheme/use_preferred_color_scheme.rs → ...olor_scheme/use_preferred_color_scheme.rs
diff --git a/std/src/geolocation/core.rs → sdk/src/geolocation/core.rs b/std/src/geolocation/core.rs → sdk/src/geolocation/core.rs
diff --git a/std/src/geolocation/mod.rs → sdk/src/geolocation/mod.rs b/std/src/geolocation/mod.rs → sdk/src/geolocation/mod.rs
diff --git a/std/src/geolocation/platform/mod.rs → sdk/src/geolocation/platform/mod.rs b/std/src/geolocation/platform/mod.rs → sdk/src/geolocation/platform/mod.rs
diff --git a/std/src/geolocation/platform/wasm.rs → sdk/src/geolocation/platform/wasm.rs b/std/src/geolocation/platform/wasm.rs → sdk/src/geolocation/platform/wasm.rs
diff --git a/std/src/geolocation/platform/windows.rs → sdk/src/geolocation/platform/windows.rs b/std/src/geolocation/platform/windows.rs → sdk/src/geolocation/platform/windows.rs
diff --git a/std/src/geolocation/use_geolocation.rs → sdk/src/geolocation/use_geolocation.rs b/std/src/geolocation/use_geolocation.rs → sdk/src/geolocation/use_geolocation.rs
diff --git a/std/src/i18n/mod.rs → sdk/src/i18n/mod.rs b/std/src/i18n/mod.rs → sdk/src/i18n/mod.rs
diff --git a/std/src/i18n/tanslate.rs → sdk/src/i18n/tanslate.rs b/std/src/i18n/tanslate.rs → sdk/src/i18n/tanslate.rs
diff --git a/std/src/i18n/use_i18n.rs → sdk/src/i18n/use_i18n.rs b/std/src/i18n/use_i18n.rs → sdk/src/i18n/use_i18n.rs
diff --git a/std/src/i18n/use_init_i18n.rs → sdk/src/i18n/use_init_i18n.rs b/std/src/i18n/use_init_i18n.rs → sdk/src/i18n/use_init_i18n.rs
diff --git a/std/src/lib.rs → sdk/src/lib.rs b/std/src/lib.rs → sdk/src/lib.rs
diff --git a/std/src/notification/mod.rs → sdk/src/notification/mod.rs b/std/src/notification/mod.rs → sdk/src/notification/mod.rs
diff --git a/std/src/notification/notification.rs → sdk/src/notification/notification.rs b/std/src/notification/notification.rs → sdk/src/notification/notification.rs
@@ -8,7 +8,7 @@ use std::fmt;
 /// # Examples
 ///
 /// ```
-/// use dioxus_std::notification::Notification;
+/// use dioxus_sdk::notification::Notification;
 ///
 /// Notification::new()
 ///     .app_name("dioxus test".to_string())

diff --git a/std/src/storage/client_storage/fs.rs → sdk/src/storage/client_storage/fs.rs b/std/src/storage/client_storage/fs.rs → sdk/src/storage/client_storage/fs.rs
diff --git a/std/src/storage/client_storage/memory.rs → sdk/src/storage/client_storage/memory.rs b/std/src/storage/client_storage/memory.rs → sdk/src/storage/client_storage/memory.rs
diff --git a/std/src/storage/client_storage/mod.rs → sdk/src/storage/client_storage/mod.rs b/std/src/storage/client_storage/mod.rs → sdk/src/storage/client_storage/mod.rs
@@ -2,15 +2,15 @@
 /// Set the directory where the storage files are located on non-wasm targets.
 ///
 /// ```rust
-/// use dioxus_std::set_dir;
+/// use dioxus_sdk::set_dir;
 ///
 /// fn main(){
 ///     // set the directory to the default location
 ///     set_dir!();
 /// }
 /// ```
 /// ```rust
-/// use dioxus_std::set_dir;
+/// use dioxus_sdk::set_dir;
 ///
 /// fn main(){
 ///     // set the directory to a custom location

diff --git a/std/src/storage/client_storage/web.rs → sdk/src/storage/client_storage/web.rs b/std/src/storage/client_storage/web.rs → sdk/src/storage/client_storage/web.rs
diff --git a/std/src/storage/mod.rs → sdk/src/storage/mod.rs b/std/src/storage/mod.rs → sdk/src/storage/mod.rs
@@ -2,7 +2,7 @@
 //! A library for handling local storage ergonomically in Dioxus
 //! ## Usage
 //! ```rust
-//! use dioxus_std::storage::use_persistent;
+//! use dioxus_sdk::storage::use_persistent;
 //! use dioxus::prelude::*;
 //!
 //! fn app() -> Element {
@@ -53,7 +53,7 @@ pub use client_storage::{set_dir_name, set_directory};
 /// ## Usage
 ///
 /// ```rust
-/// use dioxus_std::storage::{use_storage, StorageBacking};
+/// use dioxus_sdk::storage::{use_storage, StorageBacking};
 /// use dioxus::prelude::*;
 /// use dioxus_signals::Signal;
 ///
@@ -78,7 +78,7 @@ where
 /// ## Usage
 ///
 /// ```rust
-/// use dioxus_std::storage::{new_storage, StorageBacking};
+/// use dioxus_sdk::storage::{new_storage, StorageBacking};
 /// use dioxus::prelude::*;
 /// use dioxus_signals::Signal;
 ///

diff --git a/std/src/storage/persistence.rs → sdk/src/storage/persistence.rs b/std/src/storage/persistence.rs → sdk/src/storage/persistence.rs
diff --git a/std/src/utils/channel/mod.rs → sdk/src/utils/channel/mod.rs b/std/src/utils/channel/mod.rs → sdk/src/utils/channel/mod.rs
diff --git a/std/src/utils/channel/use_channel.rs → sdk/src/utils/channel/use_channel.rs b/std/src/utils/channel/use_channel.rs → sdk/src/utils/channel/use_channel.rs
diff --git a/std/src/utils/channel/use_listen_channel.rs → sdk/src/utils/channel/use_listen_channel.rs b/std/src/utils/channel/use_listen_channel.rs → sdk/src/utils/channel/use_listen_channel.rs
diff --git a/std/src/utils/mod.rs → sdk/src/utils/mod.rs b/std/src/utils/mod.rs → sdk/src/utils/mod.rs