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

Create things like contribution.md, readme.md, code of conduct #6

Open
sander1095 opened this issue Oct 6, 2021 · 2 comments
Open
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@sander1095
Copy link
Owner

sander1095 commented Oct 6, 2021

Some suggestions on how you would set these up would be nice BEFORE a PR is created

Suggestions:

  • Take a look at the Scrutor Library for (IMO) a good setup
  • Perhaps add some nice fun badges (More badges like a CI/CD and nuget badge should be added in Setup publishing to NuGet #3)
  • I don't know much about a code of conduct yet.
@sander1095 sander1095 added good first issue Good for newcomers help wanted Extra attention is needed documentation Improvements or additions to documentation and removed help wanted Extra attention is needed labels Oct 6, 2021
@sander1095
Copy link
Owner Author

@sander1095
Copy link
Owner Author

First setup of readme?


# Munisio

A library that adds testable, flexible and wonderful HATEOAS support to ASP.NET Core. 🚀

## Why you should use this library
Other HATEOAS libraries for .NET exist! I am just not the biggest fan of their configuration and testability.
I really like being able to test my code, and I like being able to make my HATEOAS configuration ✨dynamic✨.
For example, only adding a DELETE link if the user is allowed to perform that action! This library supports this!

I believe that HATEOAS can be very useful when you want to reduce duplicate code that exist on your clients and server.
The main goal of HATEOAS is not to achieve that, but I believe that this is its' most useful feature in today's web. For more information, take a look at some examples below and the `samples/` folder.

## Installation

Package is coming soon... (see #3)


## Usage

## Examples

## Contributing

Take a look at `CONTRIBUTION.MD` (coming soon..)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant