Skip to content

Commit

Permalink
Added NuGet readme
Browse files Browse the repository at this point in the history
  • Loading branch information
lpeyr committed Jul 28, 2023
1 parent 08e8abc commit e28d948
Showing 1 changed file with 124 additions and 0 deletions.
124 changes: 124 additions & 0 deletions NUGET_README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,124 @@
![GitHub contributors](https://img.shields.io/github/contributors/DevuysCode/XValid)
![GitHub issues](https://img.shields.io/github/issues/DevuysCode/XValid)
![GitHub](https://img.shields.io/github/license/DevuysCode/XValid)
![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/DevuysCode/XValid/dotnet.yml?branch=main)
![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/DevuysCode/XValid)

# XValid - A Simple Validator Library

A simple validator library for various things, such as coordinates, credit cards, domain names, emails, IBANs, IP addresses, ISBNs, and more.

[View documentation »](https://dev.peyronnet.group/xvalid/) · [Report Bug](https://github.com/DevuysCode/XValid/issues/new?assignees=&labels=bug&template=bug-report.yml&title=%5BBug%5D+) · [Request Feature](https://github.com/DevuysCode/XValid/issues/new?assignees=&labels=enhancement&template=feature-request.yml&title=%5BEnhancement%5D+)

## Features

- [x] Validate coordinates.
- [x] Validate credit card numbers.
- [x] Validate domain names.
- [x] Validate email addresses.
- [x] Validate IBANs.
- [x] Validate IP addresses.
- [x] Validate ISBNs.
- [ ] More features are planned for future releases.

## How to Use

1. Install XValid via NuGet using the following command:

```
Install-Package XValid
```

or

```
dotnet add package XValid
```

2. Import the `XValid` namespace in your C# code.

3. Start validating!

### Coordinate Validation

```csharp
using XValid;

double latitude = 40.7128; // Example latitude
double longitude = -74.0060; // Example longitude
bool isValidCoordinate = CoordinateValidator.IsValidCoordinate(latitude, longitude);
```

### Credit Card Validation

```csharp
using XValid;

string creditCardNumber = "4111 1111 1111 1111"; // Example card number (Visa)
bool isValidCreditCard = CreditCardValidator.IsValidCreditCardNumber(creditCardNumber);
```

### Domain Name Validation

```csharp
using XValid;

string domainName = "example.com";
bool isValidDomainName = DomainNameValidator.IsValid(domainName);
```

### Email Validation

```csharp
using XValid;

string email = "[email protected]";
bool isValidEmail = EmailValidator.IsValidEmail(email);
```

### IBAN Validation

```csharp
using XValid;

string iban = "DE89370400440532013000"; // Example IBAN (Germany)
bool isValidIBAN = IBANValidator.IsValidIBAN(iban);
```

### IP Address Validation

```csharp
using XValid;

string ipAddress = "192.0.2.1"; // Example IP address
bool isValidIPAddress = IPAddressValidator.IsValidIPAddress(ipAddress);
```

### ISBN Validation

```csharp
using XValid;

string isbn = "978-3-16-148410-0";
bool isValidISBN = ISBNValidator.IsValidISBN(isbn);
```

## Contribution Guidelines

To contribute to XValid, follow these steps:

1. Ensure you have the following tools installed:
- Visual Studio 2022 v17.0 or higher
- .NET 6.0 SDK
- Git
- .NET 6
2. Fork the XValid repository and clone it to your local machine.
3. Make your changes or add new features.
4. Write tests to ensure the changes are functioning as expected.
5. Submit a pull request to the main repository.

For more detailed guidelines, check out the [contribution guidelines](CONTRIBUTING.md).

## License

This project is under the [MIT License](LICENSE).

0 comments on commit e28d948

Please sign in to comment.