From 5b23875e00dd4f75c2dcdbfc8786e71c5905c227 Mon Sep 17 00:00:00 2001
From: Daniel Morandini <danielmorandini@me.com>
Date: Wed, 25 Sep 2024 12:17:29 +0200
Subject: [PATCH] Cleanup README, add package definition

---
 README.md | 24 ------------------------
 mix.exs   | 27 +++++++++++++++++++++++++++
 2 files changed, 27 insertions(+), 24 deletions(-)

diff --git a/README.md b/README.md
index dbb6bac..5c00730 100644
--- a/README.md
+++ b/README.md
@@ -10,30 +10,6 @@ for some usage examples.
 Initial table/packet parsing code was copied verbatim from
 https://github.com/membraneframework/membrane_mpegts_plugin.
 
-## Installation
-```elixir
-def deps do
-  [
-    {:kim_mpeg_ts, github: "kim-company/kim_mpeg_ts"}
-  ]
-end
-```
-
-## Gotchas
-### On LFS (if tests are failing
-Beware that fixtures are stored using the git LFS protocol. On debian, set it up
-with
-```
-% sudo apt install git-lfs
-# Within the repo
-% git lfs install
-% git lfs pull
-```
-
-If you add more fixture files, track them on LFS with `git lfs track <the
-files>`.
-
-
 ## Copyright and License
 Copyright 2022, [KIM Keep In Mind GmbH](https://www.keepinmind.info/)
 Licensed under the [Apache License, Version 2.0](LICENSE)
diff --git a/mix.exs b/mix.exs
index 9117cff..e0140c9 100644
--- a/mix.exs
+++ b/mix.exs
@@ -8,10 +8,37 @@ defmodule MPEG.TS.MixProject do
       elixir: "~> 1.14",
       elixirc_paths: elixirc_paths(Mix.env()),
       start_permanent: Mix.env() == :prod,
+      source_url: "https://github.com/kim-company/kim_mpeg_ts",
+      description: description(),
+      package: package(),
       deps: deps()
     ]
   end
 
+  defp description do
+    """
+    MPEG Transport Stream (TS) library. Deserializes packets and demuxes them (no
+    serializer nor muxer).
+
+    This library is the base of our [MPEG.TS plugin for the Membrane
+    Framework](https://github.com/kim-company/membrane_mpeg_ts_plugin) which is
+    being battle-tested with production workloads. Checkout its code and the tests
+    for some usage examples.
+
+    Initial table/packet parsing code was copied verbatim from
+    https://github.com/membraneframework/membrane_mpegts_plugin.
+    """
+  end
+
+  defp package do
+    [
+      organization: "kim_company",
+      files: ~w(lib mix.exs README.md LICENSE),
+      licenses: ["Apache-2.0"],
+      links: %{"GitHub" => "https://github.com/kim-company/kim_mpeg_ts"}
+    ]
+  end
+
   # Run "mix help compile.app" to learn about applications.
   def application do
     [