Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

tiny readme changes #40

Merged
merged 2 commits into from
Dec 31, 2023
Merged

Conversation

merlindru
Copy link
Contributor

Hi! I absolutely love ormlite

I've made a couple very small changes to the readme

  • Fixed the import/path of SqliteConnection
  • Added some extra whitespace to the code samples (I realize this is largely personal preference, happy to revert)
  • Added a cargo add snippet for easy copying

First, update your `Cargo.toml`:
Install with `cargo`:

```ps
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This uses ps because of the nice syntax highlighting

@@ -36,14 +37,15 @@ pub struct Person {
#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
/// Start by making a database connection.
let mut conn = ormlite::SqliteConnection::connect(":memory:").await.unwrap();
let mut conn = SqliteConnection::connect(":memory:").await.unwrap();
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Before, this was ormlite::SqliteConnection but really should have been ormlite::sqlite::SqliteConnection

Because the latter is pretty lengthy, I changed it to a use instead

@kurtbuilds kurtbuilds merged commit 52461fe into kurtbuilds:master Dec 31, 2023
1 check passed
@kurtbuilds
Copy link
Owner

Thank you! I updated two other callsites in the readme.

@merlindru merlindru deleted the merlin/readme-changes branch December 31, 2023 12:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants