Skip to content

Commit

Permalink
doc: Update all documentation, set gleam toml fields
Browse files Browse the repository at this point in the history
  • Loading branch information
custompro98 committed Jul 10, 2024
1 parent 9008b70 commit 19e41a9
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 6 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
[![Package Version](https://img.shields.io/hexpm/v/glibsql)](https://hex.pm/packages/glibsql)
[![Hex Docs](https://img.shields.io/badge/hex-docs-ffaff3)](https://hexdocs.pm/glibsql/)

Glibsql is a library for interacting with a hosted libSQL database such as [Turso](https://turso.io).
Glibsql is a library for interacting with a hosted libSQL database such as [Turso](https://turso.tech).

Glibsql helps construct a `gleam/http/request` for use with the [Hrana over HTTP](https://docs.turso.tech/sdk/http/reference) variant of libSQL,
simply pass the constructed HTTP request into your http client of choice.
Expand Down
11 changes: 7 additions & 4 deletions gleam.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,13 @@ version = "0.1.0"
# Fill out these fields if you intend to generate HTML documentation or publish
# your project to the Hex package manager.
#
# description = ""
# licences = ["Apache-2.0"]
# repository = { type = "github", user = "username", repo = "project" }
# links = [{ title = "Website", href = "https://gleam.run" }]
description = "Glibsql is a library for interacting with a hosted libSQL database such as [Turso](https://turso.tech)."
licences = ["Apache-2.0"]
repository = { type = "github", user = "custompro98", repo = "glibsql" }
links = [
{ title = "Turso", href = "https://turso.tech" },
{ title = "Hrana over HTTP", href = "https://docs.turso.tech/sdk/http/reference"}
]
#
# For a full reference of all the available options, you can have a look at
# https://gleam.run/writing-gleam/gleam-toml/.
Expand Down
2 changes: 1 addition & 1 deletion src/glibsql.gleam
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
//// Glibsql is a library for interacting with a hosted libSQL database such as [Turso](https://turso.io).
//// Glibsql is a library for interacting with a hosted libSQL database such as [Turso](https://turso.tech).
////
//// Glibsql helps construct a `gleam/http/request` for use with the [Hrana over HTTP](https://docs.turso.tech/sdk/http/reference) variant of libSQL,
//// simply pass the constructed HTTP request into your http client of choice.
Expand Down

0 comments on commit 19e41a9

Please sign in to comment.