SHANGSHIELD.ML 🐉 🐫

An OCaml package to measure the security of passwords. 🐉 🐫

ABOUT 📚

This repository contains an OCaml package to check the security of your passwords using the Shang algorithm.

USAGE 🔨

Requirements

To use this library, you will have to have the following tools installed and available as commands from a shell session:

• The OCaml compiler: The compiler for OCaml code.
• Opam: OCaml's package manager.
• Dune: OCaml's build tool.

Installation

To use Shangshield.ml in your OCaml project, please execute the following commands from a shell session:

• 1.) Tell Opam about Shangshield:

opam pin add git+https://github.com/alyxshang/shangshield.ml#v.0.1.0

• 2.) Install Shangshield into your Opam switch:

opam install shangshield

After these commands have been executed, you must also add the expression shangshield to your dune-project file and any dune files. The library's APIs can be included in any OCaml code by including the line open Shangshield.

API Documentation

To generate this package's API documentation, please run the commands opam install . and dune build @doc from this repository's root. The generated documentation will be in the directory _build/default/_doc/_html/ inside the repository's root.

Unit tests

To run the included unit tests, please run the commands opam install . and dune runtest from this repository's root.

Linting checks

To run a linter on the code, please run the commands opam install . and dune fmt from this repository's root.

CHANGELOG ✒️

Version 0.1.0

• Initial release.
• Upload to GitHub.

NOTE 📜

• Shangshield.ml 🐉 🐫 by Alyx Shang 🖤.
• Licensed under the FSL v1.