From 19e41a948a330d7e563ac7d1b1ef3ffb4d357b4e Mon Sep 17 00:00:00 2001 From: custompro98 Date: Wed, 10 Jul 2024 15:10:31 -0400 Subject: [PATCH] doc: Update all documentation, set gleam toml fields --- README.md | 2 +- gleam.toml | 11 +++++++---- src/glibsql.gleam | 2 +- 3 files changed, 9 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 67b29b5..0675f4f 100644 --- a/README.md +++ b/README.md @@ -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. diff --git a/gleam.toml b/gleam.toml index 3a2ce70..4c5a03b 100644 --- a/gleam.toml +++ b/gleam.toml @@ -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/. diff --git a/src/glibsql.gleam b/src/glibsql.gleam index ad205a6..689637d 100644 --- a/src/glibsql.gleam +++ b/src/glibsql.gleam @@ -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.