CI, README, package, docs

Author: josevalim

.github/workflows/ci.yml

@@ -0,0 +1,55 @@
+name: CI
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+
+jobs:
+  test:
+    runs-on: ubuntu-22.04
+    env:
+      MIX_ENV: test
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - pair:
+              elixir: "1.15"
+              otp: "25"
+          - pair:
+              elixir: "1.19"
+              otp: "28"
+            lint: lint
+    steps:
+      - uses: actions/checkout@v5
+
+      - uses: erlef/setup-beam@v1
+        with:
+          otp-version: ${{matrix.pair.otp}}
+          elixir-version: ${{matrix.pair.elixir}}
+
+      - uses: actions/cache@v4
+        with:
+          path: |
+            deps
+            _build
+          key: ${{ runner.os }}-mix-${{matrix.pair.elixir}}-${{matrix.pair.otp}}-${{ hashFiles('**/mix.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-mix-${{matrix.pair.elixir}}-${{matrix.pair.otp}}
+
+      - run: mix deps.get
+
+      - run: mix format --check-formatted
+        if: ${{ matrix.lint }}
+
+      - run: mix deps.unlock --check-unused
+        if: ${{ matrix.lint }}
+
+      - run: mix deps.compile
+
+      - run: mix compile --warnings-as-errors
+        if: ${{ matrix.lint }}
+
+      - run: mix test

README.md

@@ -1,24 +1,82 @@
 # Schemecto
 
-**TODO: Add description**
+Schemecto provides schemaless Ecto changesets with support for nested schemaless changesets and JSON Schema generation.
+
+## Usage
+
+Define types and validation functions for your data structures:
+
+```elixir
+defmodule Example do
+  def changeset(params) do
+    types = %{
+      name: :string,
+      email: :string,
+      address: Schemecto.one(
+        %{street: :string, city: :string, zip: :string},
+        with: &Example.validate_address/2
+      )
+    }
+
+    Schemecto.new(types)
+    |> Ecto.Changeset.cast(params, [:name, :email, :address])
+    |> Ecto.Changeset.validate_required([:name, :email])
+    |> Ecto.Changeset.validate_format(:email, ~r/@/)
+  end
+
+  def validate_address(changeset, params) do
+    changeset
+    |> Ecto.Changeset.cast(params, [:street, :city, :zip])
+    |> Ecto.Changeset.validate_required([:street, :city])
+    |> Ecto.Changeset.validate_length(:zip, is: 5)
+  end
+end
+```
+
+Since Schemecto is built on Ecto changesets, you can use all standard Ecto validation functions. The types map can be constructed dynamically at runtime, making it ideal for scenarios where the schema must be composed at runtime.
+
+## JSON Schema Generation
+
+Convert your changesets to JSON Schema to generate API documentation, validate client-side forms, or integrate with other tools:
+
+```elixir
+Schemecto.to_json_schema(changeset)
+```
+
+The generated schema includes required fields, format patterns, length constraints, numeric bounds, and enum fields from your changeset. For instance, the changeset above will emit:
+
+```json
+%{
+  "properties" => %{
+    "address" => %{
+      "properties" => %{
+        "city" => %{"type" => "string"},
+        "street" => %{"type" => "string"},
+        "zip" => %{"maxLength" => 5, "minLength" => 5, "type" => "string"}
+      },
+      "required" => ["street", "city"],
+      "type" => "object"
+    },
+    "email" => %{"pattern" => "@", "type" => "string"},
+    "name" => %{"type" => "string"}
+  },
+  "required" => ["name", "email"],
+  "type" => "object"
+}
+```
 
 ## Installation
 
-If [available in Hex](https://hex.pm/docs/publish), the package can be installed
-by adding `schemecto` to your list of dependencies in `mix.exs`:
+Add `schemecto` to your dependencies in `mix.exs`:
 
 ```elixir
 def deps do
   [
-    {:schemecto, "~> 0.1.0"}
+    {:schemecto, github: "josevalim/schemecto"}
   ]
 end
 ```
 
-Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)
-and published on [HexDocs](https://hexdocs.pm). Once published, the docs can
-be found at <https://hexdocs.pm/schemecto>.
-
 ## License
 
 Copyright 2026 José Valim

mix.exs

@@ -1,14 +1,23 @@
 defmodule Schemecto.MixProject do
   use Mix.Project
 
+  @version "0.1.0"
+  @repo_url "https://github.com/josevalim/schemecto"
   def project do
     [
       app: :schemecto,
-      version: "0.1.0",
+      version: @version,
       elixir: "~> 1.15",
-      start_permanent: Mix.env() == :prod,
       elixirc_paths: if(Mix.env() == :test, do: ["lib", "test/support"], else: ["lib"]),
-      deps: deps()
+      deps: deps(),
+
+      # Hex
+      package: package(),
+      description: "Schemaless Ecto changesets with support for nesting and JSON Schemas",
+
+      # Docs
+      name: "Schemecto",
+      docs: &docs/0
     ]
   end
 
@@ -17,6 +26,29 @@ defmodule Schemecto.MixProject do
   end
 
   defp deps do
-    [{:ecto, "~> 3.12"}]
+    [
+      {:ecto, "~> 3.12"},
+      {:ex_doc, "~> 0.34", only: :docs}
+    ]
+  end
+
+  defp package do
+    [
+      licenses: ["Apache-2.0"],
+      links: %{
+        "GitHub" => @repo_url,
+        "Changelog" => "#{@repo_url}/blob/main/CHANGELOG.md"
+      }
+    ]
+  end
+
+  defp docs do
+    [
+      # The main page in the docs
+      main: "readme",
+      extras: ["README.md"]
+      source_ref: "v#{@version}",
+      source_url: @repo_url
+    ]
   end
 end

mix.lock

@@ -1,5 +1,11 @@
 %{
   "decimal": {:hex, :decimal, "2.3.0", "3ad6255aa77b4a3c4f818171b12d237500e63525c2fd056699967a3e7ea20f62", [:mix], [], "hexpm", "a4d66355cb29cb47c3cf30e71329e58361cfcb37c34235ef3bf1d7bf3773aeac"},
+  "earmark_parser": {:hex, :earmark_parser, "1.4.44", "f20830dd6b5c77afe2b063777ddbbff09f9759396500cdbe7523efd58d7a339c", [:mix], [], "hexpm", "4778ac752b4701a5599215f7030989c989ffdc4f6df457c5f36938cc2d2a2750"},
   "ecto": {:hex, :ecto, "3.13.5", "9d4a69700183f33bf97208294768e561f5c7f1ecf417e0fa1006e4a91713a834", [:mix], [{:decimal, "~> 2.0", [hex: :decimal, repo: "hexpm", optional: false]}, {:jason, "~> 1.0", [hex: :jason, repo: "hexpm", optional: true]}, {:telemetry, "~> 0.4 or ~> 1.0", [hex: :telemetry, repo: "hexpm", optional: false]}], "hexpm", "df9efebf70cf94142739ba357499661ef5dbb559ef902b68ea1f3c1fabce36de"},
+  "ex_doc": {:hex, :ex_doc, "0.39.3", "519c6bc7e84a2918b737aec7ef48b96aa4698342927d080437f61395d361dcee", [:mix], [{:earmark_parser, "~> 1.4.44", [hex: :earmark_parser, repo: "hexpm", optional: false]}, {:makeup_c, ">= 0.1.0", [hex: :makeup_c, repo: "hexpm", optional: true]}, {:makeup_elixir, "~> 0.14 or ~> 1.0", [hex: :makeup_elixir, repo: "hexpm", optional: false]}, {:makeup_erlang, "~> 0.1 or ~> 1.0", [hex: :makeup_erlang, repo: "hexpm", optional: false]}, {:makeup_html, ">= 0.1.0", [hex: :makeup_html, repo: "hexpm", optional: true]}], "hexpm", "0590955cf7ad3b625780ee1c1ea627c28a78948c6c0a9b0322bd976a079996e1"},
+  "makeup": {:hex, :makeup, "1.2.1", "e90ac1c65589ef354378def3ba19d401e739ee7ee06fb47f94c687016e3713d1", [:mix], [{:nimble_parsec, "~> 1.4", [hex: :nimble_parsec, repo: "hexpm", optional: false]}], "hexpm", "d36484867b0bae0fea568d10131197a4c2e47056a6fbe84922bf6ba71c8d17ce"},
+  "makeup_elixir": {:hex, :makeup_elixir, "1.0.1", "e928a4f984e795e41e3abd27bfc09f51db16ab8ba1aebdba2b3a575437efafc2", [:mix], [{:makeup, "~> 1.0", [hex: :makeup, repo: "hexpm", optional: false]}, {:nimble_parsec, "~> 1.2.3 or ~> 1.3", [hex: :nimble_parsec, repo: "hexpm", optional: false]}], "hexpm", "7284900d412a3e5cfd97fdaed4f5ed389b8f2b4cb49efc0eb3bd10e2febf9507"},
+  "makeup_erlang": {:hex, :makeup_erlang, "1.0.3", "4252d5d4098da7415c390e847c814bad3764c94a814a0b4245176215615e1035", [:mix], [{:makeup, "~> 1.0", [hex: :makeup, repo: "hexpm", optional: false]}], "hexpm", "953297c02582a33411ac6208f2c6e55f0e870df7f80da724ed613f10e6706afd"},
+  "nimble_parsec": {:hex, :nimble_parsec, "1.4.2", "8efba0122db06df95bfaa78f791344a89352ba04baedd3849593bfce4d0dc1c6", [:mix], [], "hexpm", "4b21398942dda052b403bbe1da991ccd03a053668d147d53fb8c4e0efe09c973"},
   "telemetry": {:hex, :telemetry, "1.3.0", "fedebbae410d715cf8e7062c96a1ef32ec22e764197f70cda73d82778d61e7a2", [:rebar3], [], "hexpm", "7015fc8919dbe63764f4b4b87a95b7c0996bd539e0d499be6ec9d7f3875b79e6"},
 }