Skip to content

HyperAuth/ExPlugHyperAuth

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

40 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

HyperAuth

Hex.pm Hex.pm Hex.pm Build Status

Plug for HTTP authentication.

ExHyperAuth repository is the version of HyperAuth wrote in Elixir to use with web applications based on Plug.

Installation

The package can be installed by adding plug_hyper_auth to your list of dependencies in mix.exs:

def deps do
  [
    {:plug_hyper_auth, "~> 0.1.0"}
  ]
end

Documentation can be generated with ExDoc and is published on HexDocs. The docs can be found at https://hexdocs.pm/plug_hyper_auth.

Contribute

Contribution is welcomed. Open a [pull request][pulls] when you are ready to contribute.

If you are planning to contribute documentation, please check the best practices for writing documentation of Elixir.

Add tests for the code added and try to keep the code clean. The pull request need to pass the tests to be accepted.

Finally, remember all interactions in our official spaces follow the Elixir Code of Conduct.

Copyright

You hereby assign copyright in this code to the project, to be licensed under the same terms as the rest of the code.

You're owner of your contribution copyright, but it will be covered under HyperAuth's license and also it's shared with the rest of authors, all the contributors are authors of HyperAuth.

Read the license note section to check details about it.

Useful links

Some useful links if you want to contribute to this repository.

License note

HyperAuth is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

HyperAuth is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program. If not, see http://www.gnu.org/licenses/.

Check NOTICE and LICENSE files for more information.