diff --git a/README.md b/README.md index e512078..fa9576a 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,14 @@ # protobuf_decode_gleam +Decode the protobuf wire format! + +This is just a little toy I made mostly for myself. I would be happy to +polish it and make it work better, but for now this should not be used at all. +Unless you're really quite adventurous and are willing to reach out to me (my +email is on my github profile). + +Also, there is currently no support for encoding the protobuf wire format. + [![Package Version](https://img.shields.io/hexpm/v/protobuf_decode_gleam)](https://hex.pm/packages/protobuf_decode_gleam) [![Hex Docs](https://img.shields.io/badge/hex-docs-ffaff3)](https://hexdocs.pm/protobuf_decode_gleam/) @@ -11,6 +20,7 @@ import protobuf_decode_gleam pub fn main() -> Nil { // TODO: An example of the project in use + // See the tests, they have decent examples. } ``` diff --git a/gleam.toml b/gleam.toml index 06071cf..ff48b22 100644 --- a/gleam.toml +++ b/gleam.toml @@ -4,9 +4,9 @@ version = "1.0.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 = "", repo = "" } +description = "Decode the protobuf wire format." +licences = ["Apache-2.0"] +repository = { type = "github", user = "gavinmorrow", repo = "protobuf-decode-gleam" } # links = [{ title = "Website", href = "" }] # # For a full reference of all the available options, you can have a look at