Skip to content

Commit 6921b65

Browse files
committed
Setting up the metadata info for the project crates
1 parent 4a83fa8 commit 6921b65

18 files changed

Lines changed: 151 additions & 125 deletions

File tree

README.md

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,16 @@
1010
`Canyon-SQL` is a high level abstraction for working with multiple databases concurrently. Is build on top of the `async` language features
1111
to provide a high speed, high performant library to handling data access for consumers.
1212

13-
## Early stage advice
13+
## Early stage disclaimer
1414

1515
The library it's still on a `early stage` state.
16-
Any contrib via `fork` + `PR` it's really appreciated. Currently we are involved in a really active development on the project. Near to december 2022, first release will be published and available in `crates.io`.
16+
Any contrib via `fork` + `PR` it's really appreciated. Currently we are involved in a really active development on the project.
17+
18+
## Full documentation resources
19+
20+
There is a `work-in-progress` web page, build with `mdBook` containing the official documentation.
21+
Here is where you will find all the technical documentation for `Canyon-SQL`.
22+
You can read it [by clicking this link](https://zerodaycode.github.io/canyon-book/)
1723

1824
## Most important features
1925

@@ -33,13 +39,4 @@ Also, in the future, we have plans to allow you to manipulate the whole server,
3339

3440
Every crate listed above is an `async` based crate, in line with the guidelines of the `Canyon-SQL` design.
3541

36-
There are plans for include more databases, but is not one of the priorities of the development team nowadays.
37-
38-
## Full documentation resources
39-
40-
There is a `work-in-progress` web page, build with `mdBook` containing the official documentation.
41-
You can read it [by clicking this link](https://zerodaycode.github.io/canyon-book/)
42-
43-
> At this time, and while this comment is in this README.md file, the documentation linked above is outdated
44-
with the current library implementation. This will took to update probably several weeks, so take in consideration
45-
wait for this comment to dissapear from here, because the project is under a rewrite process.
42+
There are plans for include more databases engines.

canyon_connection/Cargo.toml

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,14 @@
11
[package]
22
name = "canyon_connection"
3-
version = "0.0.1"
3+
version = "0.1.0"
44
edition = "2021"
5+
documentation = "https://zerodaycode.github.io/canyon-book/"
6+
homepage = "https://github.com/zerodaycode/Canyon-SQL"
7+
readme = "README.md"
8+
license = "MIT"
9+
license-file = "LICENSE"
10+
Description = "A Rust ORM and QueryBuilder"
11+
512

613
[dependencies]
714
tokio = { version = "1.21.2", features = ["full"] }

canyon_crud/Cargo.toml

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,16 @@
11
[package]
22
name = "canyon_crud"
3-
version = "0.0.1"
3+
version = "0.1.0"
44
edition = "2021"
5+
documentation = "https://zerodaycode.github.io/canyon-book/"
6+
homepage = "https://github.com/zerodaycode/Canyon-SQL"
7+
readme = "README.md"
8+
license = "MIT"
9+
license-file = "LICENSE"
10+
Description = "A Rust ORM and QueryBuilder"
511

612
[dependencies]
713
chrono = { version = "0.4", features = ["serde"] }
814
async-trait = { version = "0.1.50" }
915

10-
canyon_connection = { version = "0.0.1", path = "../canyon_connection" }
16+
canyon_connection = { version = "0.1.0", path = "../canyon_connection" }

0 commit comments

Comments
 (0)