Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Prepare to release v0.04 and publish to Hex #40

Merged
merged 1 commit into from
Nov 4, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 3 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ are one of a fixed set of options.

There are two ways to use it:

1. The `union_type` macro, which replaces a normal `@type` annotation with a nice,
1. The `union_type` and `union_typep` macros, which replaces normal `@type`/`@typep` annotations with a nice,
concise macro version of the type definition.
2. `UnionTypespec.union_type_ast/1`, which produces an AST you can `unquote` within
the usual `@type` definition.
Expand All @@ -32,16 +32,12 @@ end

## Installation

We have not yet published the package to Hex, because it's not (yet?) clear
that it's valuable to anyone else. Until we do, you can still install it by
adding the following to your `mix.exs` and running `$ mix deps.get`:
You can install the package from Hex by adding this to your `mix.exs` file's dependencies:

```elixir
def deps do
[
{:union_typespec, git: "https://github.com/felt/union_typespec.git", tag: "v0.0.3", runtime: false},
{:union_typespec, "~> 0.0.4", runtime: false},
]
end
```

And if you do find it useful, we'd love to hear about it!
2 changes: 1 addition & 1 deletion mix.exs
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ defmodule UnionTypespec.MixProject do
def project do
[
app: :union_typespec,
version: "0.0.3",
version: "0.0.4",
elixir: "~> 1.12",
package: package(),
source_url: "https://github.com/felt/union_typespec",
Expand Down
Loading