Merge pull request #52 from luckynumberke7in/master

maccesch · web-flow · commit 9b0741aa3fac · 2024-08-26T13:43:52.000+01:00
Expand on usage of examples
diff --git a/examples/bootstrap/README.md b/examples/bootstrap/README.md
@@ -1,4 +1,6 @@
-A simple table example with just local data stored as `Vec<Book>` Uses the Bootstrap class provider.
+### A simple table example with just local data stored as `Vec<Book>` Uses the Bootstrap class provider.
+
+To make this example work, you must download / fork the whole repo because this is in the Cargo.toml: `leptos-struct-table = { path = "../.." }`.
 
 If you don't have it installed already, install [Trunk](https://trunkrs.dev/)
 as well as the wasm32-unknown-unknown target:
diff --git a/examples/custom_renderers_svg/README.md b/examples/custom_renderers_svg/README.md
@@ -1,4 +1,6 @@
-Example that shows how use custom renderers to render the table as SVG.
+### Example that shows how use custom renderers to render the table as SVG.
+
+To make this example work, you must download / fork the whole repo because this is in the Cargo.toml: `leptos-struct-table = { path = "../.." }`.
 
 If you don't have it installed already, install [Trunk](https://trunkrs.dev/)
 as well as the wasm32-unknown-unknown target:
diff --git a/examples/custom_row_renderer/README.md b/examples/custom_row_renderer/README.md
@@ -1,4 +1,6 @@
-A simple table example with just local data stored as `Vec<Book>` demonstrating a custom row renderer and skipping header titles.
+### A simple table example with just local data stored as `Vec<Book>` demonstrating a custom row renderer and skipping header titles.
+
+To make this example work, you must download / fork the whole repo because this is in the Cargo.toml: `leptos-struct-table = { path = "../.." }`.
 
 If you don't have it installed already, install [Trunk](https://trunkrs.dev/)
 as well as the wasm32-unknown-unknown target:
diff --git a/examples/custom_type/README.md b/examples/custom_type/README.md
@@ -1,4 +1,6 @@
-A table example with custom local data stored as `Vec<Rc<Book>>`.
+### A table example with custom local data stored as `Vec<Rc<Book>>`.
+
+To make this example work, you must download / fork the whole repo because this is in the Cargo.toml: `leptos-struct-table = { path = "../.." }`.
 
 If you don't have it installed already, install [Trunk](https://trunkrs.dev/)
 as well as the wasm32-unknown-unknown target:
diff --git a/examples/editable/README.md b/examples/editable/README.md
@@ -1,5 +1,8 @@
-A table example with editable cells and data that is stored as `Vec<Book>`.
-Uses the Tailwind class provider.
+### A table example with editable cells and data that is stored as `Vec<Book>`.
+
+To make this example work, you must download / fork the whole repo because this is in the Cargo.toml: `leptos-struct-table = { path = "../.." }`.
+
+#### Uses the Tailwind class provider.
 
 The way Tailwind works, is to scan the classes in the code. Due to this it is
 recommended to copy the file `src/class_providers/tailwind.rs` into your project as done in this example.
diff --git a/examples/generic/README.md b/examples/generic/README.md
@@ -1,4 +1,6 @@
-A table example with a generic struct.
+### A table example with a generic struct.
+
+To make this example work, you must download / fork the whole repo because this is in the Cargo.toml: `leptos-struct-table = { path = "../.." }`.
 
 If you don't have it installed already, install [Trunk](https://trunkrs.dev/)
 as well as the wasm32-unknown-unknown target:
diff --git a/examples/getter/README.md b/examples/getter/README.md
@@ -1,4 +1,6 @@
-A table example with a getter method.
+### A table example with a getter method.
+
+To make this example work, you must download / fork the whole repo because this is in the Cargo.toml: `leptos-struct-table = { path = "../.." }`.
 
 If you don't have it installed already, install [Trunk](https://trunkrs.dev/)
 as well as the wasm32-unknown-unknown target:
diff --git a/examples/i18n/README.md b/examples/i18n/README.md
@@ -1,4 +1,6 @@
-A simple table example showing how to integrate leptos-i18n to translate the titles.
+### A simple table example showing how to integrate leptos-i18n to translate the titles.
+
+To make this example work, you must download / fork the whole repo because this is in the Cargo.toml: `leptos-struct-table = { path = "../.." }`.
 
 If you don't have it installed already, install [Trunk](https://trunkrs.dev/)
 as well as the wasm32-unknown-unknown target:
diff --git a/examples/paginated_rest_datasource/README.md b/examples/paginated_rest_datasource/README.md
@@ -1,4 +1,6 @@
-Example that shows how to use a paginated REST API as a data source for a table.
+### Example that shows how to use a paginated REST API as a data source for a table.
+
+To make this example work, you must download / fork the whole repo because this is in the Cargo.toml: `leptos-struct-table = { path = "../.." }`.
 
 If you don't have it installed already, install [Trunk](https://trunkrs.dev/)
 as well as the wasm32-unknown-unknown target:
diff --git a/examples/pagination/README.md b/examples/pagination/README.md
@@ -1,4 +1,6 @@
-Example that shows how to use pagination with a table.
+### Example that shows how to use pagination with a table.
+
+To make this example work, you must download / fork the whole repo because this is in the Cargo.toml: `leptos-struct-table = { path = "../.." }`.
 
 If you don't have it installed already, install [Trunk](https://trunkrs.dev/) 
 as well as the wasm32-unknown-unknown target:
diff --git a/examples/selectable/README.md b/examples/selectable/README.md
@@ -1,4 +1,6 @@
-A table example with selectable rows and data that is stored as `Vec<Book>` Uses the Tailwind class provider.
+### A table example with selectable rows and data that is stored as `Vec<Book>` Uses the Tailwind class provider.
+
+To make this example work, you must download / fork the whole repo because this is in the Cargo.toml: `leptos-struct-table = { path = "../.." }`.
 
 The way Tailwind works, is to scan the classes in the code. Due to this it is
 recommended to copy the file `src/class_providers/tailwind.rs` into your project as done in this example.
diff --git a/examples/serverfn_sqlx/README.md b/examples/serverfn_sqlx/README.md
@@ -1,4 +1,6 @@
-A table example with a data source that uses server functions and sqlx.
+### A table example with a data source that uses server functions and sqlx.
+
+To make this example work, you must download / fork the whole repo because this is in the Cargo.toml: `leptos-struct-table = { path = "../.." }`.
 
 If you don't have `cargo-leptos` installed you can install it with
 
diff --git a/examples/simple/README.md b/examples/simple/README.md
@@ -1,4 +1,6 @@
-A simple table example with just local data stored as `Vec<Book>`.
+### A simple table example with just local data stored as `Vec<Book>`.
+
+To make this example work, you must download / fork the whole repo because this is in the Cargo.toml: `leptos-struct-table = { path = "../.." }`.
 
 If you don't have it installed already, install [Trunk](https://trunkrs.dev/)
 as well as the wasm32-unknown-unknown target:
diff --git a/examples/tailwind/README.md b/examples/tailwind/README.md
@@ -1,4 +1,6 @@
-A simple table example with just local data stored as `Vec<Book>` Uses the Tailwind class provider.
+### A simple table example with just local data stored as `Vec<Book>` Uses the Tailwind class provider.
+
+To make this example work, you must download / fork the whole repo because this is in the Cargo.toml: `leptos-struct-table = { path = "../.." }`.
 
 The way Tailwind works, is to scan the classes in the code. Due to this it is
 recommended to copy the file `src/class_providers/tailwind.rs` into your project as done in this example.
