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

Misc doc changes #21

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
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
4 changes: 4 additions & 0 deletions .formatter.exs
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Used by "mix format"
[
inputs: ["{mix,.formatter}.exs", "{config,lib,test}/**/*.{ex,exs}"]
]
30 changes: 26 additions & 4 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,8 +1,30 @@
/_build
/deps
/docs
# The directory Mix will write compiled artifacts to.
/_build/

# If you run "mix test --cover", coverage assets end up here.
/cover/

# The directory Mix downloads your dependencies sources to.
/deps/

# Where third-party dependencies like ExDoc output generated docs.
/doc/

# Ignore .fetch files in case you like to edit your project deps locally.
/.fetch

# If the VM crashes, it generates a dump, let's ignore it too.
erl_crash.dump

# Also ignore archive artifacts (built via "mix archive.build").
*.ez
.elixir_ls/

# Ignore package tarball (built via "mix hex.build").
plug_rails_cookie_session_store-*.tar

# Temporary files, for example, from tests.
/tmp/

# Misc.
.idea/
*.iml
2 changes: 1 addition & 1 deletion LICENSE.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
The MIT License (MIT)
# The MIT License (MIT)

Copyright (c) 2014 Chris Constantin

Expand Down
27 changes: 20 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,28 @@
PlugRailsCookieSessionStore
===========================
# PlugRailsCookieSessionStore

[![Module Version](https://img.shields.io/hexpm/v/plug_rails_cookie_session_store.svg)](https://hex.pm/packages/plug_rails_cookie_session_store)
[![Hex Docs](https://img.shields.io/badge/hex-docs-lightgreen.svg)](https://hexdocs.pm/plug_rails_cookie_session_store/)
[![Total Download](https://img.shields.io/hexpm/dt/plug_rails_cookie_session_store.svg)](https://hex.pm/packages/plug_rails_cookie_session_store)
[![License](https://img.shields.io/hexpm/l/plug_rails_cookie_session_store.svg)](https://github.com/cconstantin/plug_rails_cookie_session_store/blob/master/LICENSE)
[![Last Updated](https://img.shields.io/github/last-commit/cconstantin/plug_rails_cookie_session_store.svg)](https://github.com/cconstantin/plug_rails_cookie_session_store/commits/master)

Rails compatible Plug session store.

This allows you to share session information between Rails and a Plug-based framework like Phoenix.

Version Information
===================
## Version Information

Version 2.0 and higher require OTP 22 or higher.

## Installation

Add PlugRailsCookieSessionStore as a dependency to your `mix.exs` file:
Add `:plug_rails_cookie_session_store` as a dependency to your `mix.exs` file:

```elixir
def deps do
[{:plug_rails_cookie_session_store, "~> 2.0"}]
[
{:plug_rails_cookie_session_store, "~> 2.0"}
]
end
```

Expand Down Expand Up @@ -84,7 +90,7 @@ Plug & Rails must use the same strategy for serializing cookie data.
end
```

You can confirm that your app uses JSON by searching for
You can confirm that your app uses JSON by searching for:

```ruby
Rails.application.config.action_dispatch.cookies_serializer = :json
Expand Down Expand Up @@ -143,3 +149,10 @@ And print it on Phoenix in whatever Controller you want:
```elixir
Logger.debug get_session(conn, "foo")
```

## Copyright and License

Copyright (c) 2014 Chris Constantin

Released under the MIT License, which can be found in the repository in
[LICENSE.md](./LICENSE.md).
15 changes: 0 additions & 15 deletions doc/.build

This file was deleted.

128 changes: 0 additions & 128 deletions doc/404.html

This file was deleted.

145 changes: 0 additions & 145 deletions doc/PlugRailsCookieSessionStore-function-delete.html

This file was deleted.

Loading