Skip to content

Commit

Permalink
add more wip notes so i can merge to main, weeee
Browse files Browse the repository at this point in the history
  • Loading branch information
novaugust committed May 24, 2024
1 parent 7f072c1 commit 4e0d109
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,27 @@ you what's wrong, it just rewrites the code for you to fit its style rules.

You can learn more about the history, purpose and implementation of Styler from our talk: [Styler: Elixir Style-Guide Enforcer @ GigCity Elixir 2023](https://www.youtube.com/watch?v=6pF8Hl5EuD4)

-----------------------

Styler's documentation is under work as part of releasing 1.0.

You can find the [0.11.9 documentation and readme here.](https://hexdocs.pm/styler/readme.html)

## Installation

Add `:styler` as a dependency to your project's `mix.exs`:

```elixir
def deps do
[
{:styler, "~> 0.11", only: [:dev, :test], runtime: false},
{:styler, "~> 1.0.0-rc.0", only: [:dev, :test], runtime: false},
]
end
```

Please excuse the mess below as I find spare to to update our documentation =)


@TODO put this somewhere more reasonable
**Note** Styler's only public API is its usage as a formatter plugin. While you're welcome to play with its internals,
they can and will change without that change being reflected in Styler's semantic version.
Expand All @@ -42,6 +52,8 @@ Styler is @adobe's internal Style Guide Enforcer - allowing exceptions to the st

@TODO link examples

https://hexdocs.pm/styler/1.0.0-rc.0/styles.html

## Styler & Credo

@TODO link credo doc
Expand Down

0 comments on commit 4e0d109

Please sign in to comment.