Skip to content

Latest commit

 

History

History
220 lines (164 loc) · 7.88 KB

README_new.md

File metadata and controls

220 lines (164 loc) · 7.88 KB
Raw

Contributors Forks Stargazers Issues MIT License LinkedIn


Logo

Equilibrium

An opinionated, ligthweight ASP.NET Policy Provider
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

Product Name Screen Shot

Here's a blank template to get started: To avoid retyping too much info. Do a search and replace with your text editor for the following: github_username, repo_name, twitter_handle, linkedin_username, email_client, email, project_title, project_description

(back to top)

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

This library runs on .NET 6.0

Installation

You can load this library into your project through the NuGet Package Manager

Install-Package to-be-defined

(back to top)

Usage

Once you have you library correctly referenced, start by configuring your app to add the Equilibrum service:

Services.<methodToBeDefined>

Then, start by adding the ActionMapAttribute to the action methods of your application that you want to be checked for authorization.

[ActionMap("Remove stuff.")]
public Task<IActionResult> Delete() {
  // do dangerous stuff
}

To let the policy be enforced, you need to add Users to AccessGroups

For more examples, please refer to the Documentation

(back to top)

Roadmap

  • Feature 1
  • Feature 2
  • Feature 3
    • Nested Feature

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Davide Vitali - davide.bass@gmail.com

Project Link: https://github.com/davidevitali/equilibrium

(back to top)