Skip to content

Commit

Permalink
Add documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
philipgiuliani committed Nov 18, 2023
1 parent ddb7f49 commit faa072e
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 8 deletions.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,10 @@ and its documentation can be found at <https://hexdocs.pm/glubs>.
* [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

Expand Down
11 changes: 4 additions & 7 deletions gleam.toml
Original file line number Diff line number Diff line change
@@ -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"
Expand Down

0 comments on commit faa072e

Please sign in to comment.