From faa072e15d87f9e8fe5a886c163ad605b66a104a Mon Sep 17 00:00:00 2001 From: Philip Giuliani Date: Sat, 18 Nov 2023 19:29:39 +0100 Subject: [PATCH] Add documentation --- README.md | 4 +++- gleam.toml | 11 ++++------- 2 files changed, 7 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index cbfef3f..787d92e 100644 --- a/README.md +++ b/README.md @@ -20,8 +20,10 @@ and its documentation can be found at . * [x] Parses WebVTT files into a structured format * [x] Handles both comments and cues with start and end times * [x] Tokenizes WebVTT cue payload into individual tokens -* [ ] Converts a WebVTT type back to a string +* [x] Converts a WebVTT type back to a string +* [ ] Parse WebVTT metadata * [ ] Converts a list of tokens type back to a string +* [ ] Add SRT ## Example diff --git a/gleam.toml b/gleam.toml index 7246572..f99d7ad 100644 --- a/gleam.toml +++ b/gleam.toml @@ -1,13 +1,10 @@ name = "glubs" 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 = "WebVTT parser and payload tokenizer" +licences = ["Apache-2.0"] +repository = { type = "github", user = "philipgiuliani", repo = "glubs" } +links = [{ title = "Website", href = "https://github.com/philipgiuliani/glubs" }] [dependencies] gleam_stdlib = "~> 0.32"