Skip to content

Commit

Permalink
Update README with release/version notes
Browse files Browse the repository at this point in the history
  • Loading branch information
coreyti committed Sep 26, 2024
1 parent b2a03a6 commit 37a9833
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Playwright for Elixir

**NOTE:** This package is currently in "preview". The features are not yet at parity with other Playwright implementations. Once `playwright-elixir` is at or near parity with [`playwright`](https://github.com/microsoft/playwright), the version number will be updated to mirror the supported version of `playwright`.
**NOTE:** This package is currently in "preview" (or "alpha"). The features are not yet at parity with other Playwright implementations. Once `playwright-elixir` is at or near parity with [`playwright`](https://github.com/microsoft/playwright), the version number will be updated to mirror the supported version of `playwright`.

## Overview

Expand Down Expand Up @@ -45,6 +45,10 @@ defmodule Test.ExampleTest do
end
```

## Releases

This project aims to track the release versioning found in [Playwright proper](https://github.com/microsoft/playwright).

## Contributing

### Getting started
Expand All @@ -66,4 +70,4 @@ end
a. Search for and update the version anywhere it appears in the repo, such as this README
2. `git tag -a v${version_number}` such that the tag look like `v1.44.0-alpha.3` or `v1.44.0`
3. `git push --tags`
4. `mix hex.publish`
4. `mix hex.publish`

0 comments on commit 37a9833

Please sign in to comment.