tweaks to readme and mix.exs. github workflow.

lebrunel · Mar 10, 2024 · 6374a43 · 6374a43
1 parent 3af0432
commit 6374a43
Show file tree

Hide file tree

Showing 4 changed files with 57 additions and 10 deletions.
diff --git a/.github/workflows/elixir.yml b/.github/workflows/elixir.yml
@@ -0,0 +1,27 @@
+name: Elixir CI
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    name: OTP ${{matrix.otp}} / Elixir ${{matrix.elixir}}
+    strategy:
+      matrix:
+        otp: ['24.x', '25.x', '26.x']
+        elixir: ['1.13.4', '1.14.5', '1.15.7']
+        exclude:
+          - otp: '26.x'
+            elixir: '1.13.4'
+    steps:
+      - uses: actions/checkout@v2
+      - uses: erlef/setup-beam@v1
+        with:
+          otp-version: ${{matrix.otp}}
+          elixir-version: ${{matrix.elixir}}
+      - run: mix deps.get
+      - run: mix test
diff --git a/README.md b/README.md
@@ -1,12 +1,14 @@
 # Anthropix
 
- An up-to-date and simple Elixir client library for [Anthropic's REST API](https://docs.anthropic.com/claude/reference/getting-started-with-the-api).
+ An up-to-date and fully-featured Elixir client library for [Anthropic's REST API](https://docs.anthropic.com/claude/reference/getting-started-with-the-api).
 
-- 🔄 Up-to-date Elixir API client
+- ✅ API client fully implementing the Anthropic API
 - 🛜 Streaming API requests
   - Stream to an Enumerable
   - Or stream messages to any Elixir process
-- 🧩 Advanced function calling workflows (soon)
+- 🔜 Advanced and flexible function calling workflow
+
+This library is currently a WIP. Check back in a week or two, by which point it should be bangin!
 
 ## Installation
 
@@ -15,7 +17,7 @@ The package can be installed by adding `anthropix` to your list of dependencies
 ```elixir
 def deps do
   [
-    {:anthropix, "#{@version}"}
+    {:anthropix, "0.0.1"}
   ]
 end
 ```

diff --git a/lib/anthropix.ex b/lib/anthropix.ex
@@ -1,13 +1,17 @@
 defmodule Anthropix do
   @version Keyword.fetch!(Mix.Project.config(), :version)
   @moduledoc """
-  An up-to-date and simple Elixir client library for [Anthropic's REST API](https://docs.anthropic.com/claude/reference/getting-started-with-the-api).
+  An up-to-date and fully-featured Elixir client library for
+  [Anthropic's REST API](https://docs.anthropic.com/claude/reference/getting-started-with-the-api).
 
-  - 🔄 Up-to-date Elixir API client
+  - ✅ API client fully implementing the Anthropic API
   - 🛜 Streaming API requests
     - Stream to an Enumerable
     - Or stream messages to any Elixir process
-  - 🧩 Advanced function calling workflows (soon)
+  - 🔜 Advanced and flexible function calling workflow
+
+  This library is currently a WIP. Check back in a week or two, by which point
+  it should be bangin!
 
   ## Installation
 

diff --git a/mix.exs b/mix.exs
@@ -4,11 +4,25 @@ defmodule Anthropix.MixProject do
   def project do
     [
       app: :anthropix,
-      version: "0.1.0",
-      elixir: "~> 1.15",
+      name: "Anthropix",
+      description: "todo",
+      source_url: "https://github.com/lebrunel/anthropix",
+      version: "0.0.1",
+      elixir: "~> 1.13",
       elixirc_paths: elixirc_paths(Mix.env()),
       start_permanent: Mix.env() == :prod,
-      deps: deps()
+      deps: deps(),
+      docs: [
+        main: "Anthropix"
+      ],
+      package: [
+        name: "anthropix",
+        files: ~w(lib .formatter.exs mix.exs README.md LICENSE),
+        licenses: ["Apache-2.0"],
+        links: %{
+          "GitHub" => "https://github.com/lebrunel/anthropix"
+        }
+      ]
     ]
   end