From 11d959d0bd5514813e9a6c11d7bd23348ab7389e Mon Sep 17 00:00:00 2001 From: Steffen Beyer Date: Mon, 6 Apr 2026 08:54:20 +0200 Subject: [PATCH] build: LICENSE, prepare Hex release --- LICENSE | 25 +++++++++++++++++++++++++ README.md | 2 -- mix.exs | 26 ++++++++++++++++++++------ 3 files changed, 45 insertions(+), 8 deletions(-) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..de44273 --- /dev/null +++ b/LICENSE @@ -0,0 +1,25 @@ +BSD 2-Clause License + +Copyright (c) 2026, Steffen Beyer +All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met: + +1. Redistributions of source code must retain the above copyright notice, this + list of conditions and the following disclaimer. + +2. Redistributions in binary form must reproduce the above copyright notice, + this list of conditions and the following disclaimer in the documentation + and/or other materials provided with the distribution. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE +FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR +SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER +CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, +OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. diff --git a/README.md b/README.md index b9ef301..facd44f 100644 --- a/README.md +++ b/README.md @@ -668,5 +668,3 @@ For Marmot client end-to-end checks (TypeScript/Node suite using `marmot-ts`, in ```bash just e2e marmot ``` - -``` diff --git a/mix.exs b/mix.exs index af767de..756a260 100644 --- a/mix.exs +++ b/mix.exs @@ -10,7 +10,9 @@ defmodule Parrhesia.MixProject do start_permanent: Mix.env() == :prod, deps: deps(), aliases: aliases(), - docs: docs() + docs: docs(), + description: description(), + package: package() ] end @@ -52,15 +54,17 @@ defmodule Parrhesia.MixProject do {:telemetry_poller, "~> 1.0"}, {:telemetry_metrics_prometheus, "~> 1.1"}, + # Runtime: outbound WebSocket client (sync transport) + {:websockex, "~> 0.4"}, + # Test tooling {:stream_data, "~> 1.0", only: :test}, - {:websockex, "~> 0.4"}, # Project tooling {:credo, "~> 1.7", only: [:dev, :test], runtime: false}, {:ex_doc, "~> 0.34", only: :dev, runtime: false}, - {:deps_changelog, "~> 0.3"}, - {:igniter, "~> 0.6", only: [:dev, :test]} + {:deps_changelog, "~> 0.3", only: :dev, runtime: false}, + {:igniter, "~> 0.6", only: [:dev, :test], runtime: false} ] end @@ -82,6 +86,17 @@ defmodule Parrhesia.MixProject do ] end + defp description do + "Nostr event relay with WebSocket fanout, sync, and access control" + end + + defp package do + [ + licenses: ["BSD-2-Clause"], + links: %{"Gitea" => "https://git.teralink.net/tribes/parrhesia"} + ] + end + defp docs do [ main: "readme", @@ -91,8 +106,7 @@ defmodule Parrhesia.MixProject do "docs/LOCAL_API.md", "docs/SYNC.md", "docs/ARCH.md", - "docs/CLUSTER.md", - "BENCHMARK.md" + "docs/CLUSTER.md" ], groups_for_modules: [ "Embedded API": [