Skip to content

Latest commit

 

History

History
40 lines (26 loc) · 1.05 KB

README.md

File metadata and controls

40 lines (26 loc) · 1.05 KB
Raw

Birbnest

Build Status

Birbnest is a plug's Store implementation using Agent. This allows you to store your session data in a process which can be directly messaged in a distributed network unlike ETS.

Usage

  1. Add birbnest to your list of dependencies in mix.exs:
```elixir
def deps do
  [{:birbnest, "~> 0.1"}]
end
```
  1. Ensure birbnest is started before your application:
```elixir
def application do
  [applications: [:birbnest]]
end
```
  1. If you are using Phoenix Framework, you need to change the Session plug setting in the application's Endpoint module.
```elixir
plug Plug.Session,
  store: Birbnest.Nest
```

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

License

This project is licensed under the MIT License - see the LICENSE.md file for details