Skip to content

Commit

Permalink
add readme nuget
Browse files Browse the repository at this point in the history
  • Loading branch information
matmiranda committed Aug 12, 2023
1 parent a684beb commit 3b8ead3
Show file tree
Hide file tree
Showing 3 changed files with 106 additions and 4 deletions.
4 changes: 2 additions & 2 deletions PagBank.sln
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@ Microsoft Visual Studio Solution File, Format Version 12.00
# Visual Studio Version 17
VisualStudioVersion = 17.6.33829.357
MinimumVisualStudioVersion = 10.0.40219.1
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "PagBank", "PagBank\PagBank.csproj", "{BDA7C10B-4354-4E79-A598-1AC8B796AD06}"
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "PagBank", "PagBank\PagBank.csproj", "{BDA7C10B-4354-4E79-A598-1AC8B796AD06}"
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "PagBankTest", "PagBankTest\PagBankTest.csproj", "{E62EB06F-3B6D-4846-A61A-08B4CFDB971D}"
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "PagBankTest", "PagBankTest\PagBankTest.csproj", "{E62EB06F-3B6D-4846-A61A-08B4CFDB971D}"
EndProject
Global
GlobalSection(SolutionConfigurationPlatforms) = preSolution
Expand Down
4 changes: 2 additions & 2 deletions PagBank/PagBank.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<RepositoryType>git</RepositoryType>
<PackageLicenseFile>LICENSE</PackageLicenseFile>
<Copyright>Copyright (c) 2023 Matheus Miranda</Copyright>
<PackageReadmeFile>README.md</PackageReadmeFile>
<PackageReadmeFile>README-NUGET.md</PackageReadmeFile>
<PackageIcon>pagbank.png</PackageIcon>
</PropertyGroup>

Expand All @@ -30,7 +30,7 @@
<Pack>True</Pack>
<PackagePath>\</PackagePath>
</None>
<None Include="..\README.md">
<None Include="..\README-NUGET.md">
<Pack>True</Pack>
<PackagePath>\</PackagePath>
</None>
Expand Down
102 changes: 102 additions & 0 deletions README-NUGET.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,102 @@
# pagbank-dotnet

[![License](https://img.shields.io/badge/license-MIT-green)](./LICENSE)
![dotnet status](https://github.com/matmiranda/pagbank-dotnet/actions/workflows/dotnet.yml/badge.svg?event=push)
[![NuGet Badge](https://buildstats.info/nuget/pagbank-dotnet)](https://www.nuget.org/packages/pagbank-dotnet)

Bem-vindo ao repositório da _**pagbank-dotnet**_!

Esta biblioteca é uma solução poderosa para facilitar a integração de serviços RESTful em seus aplicativos .NET usando o RestSharp.

## Visão Geral

A _**pagbank-dotnet**_ foi desenvolvida para simplificar e agilizar a comunicação com APIs RESTful. Ela oferece recursos avançados e uma integração perfeita com o RestSharp para realizar operações assíncronas, processar dados, autenticar solicitações e muito mais.

## Principais Recursos

- Integração perfeita com o RestSharp para chamadas RESTful
- Suporte a autenticação segura e gerenciamento de tokens
- Operações assíncronas eficientes para não bloquear a thread principal
- Abstração de dados para simplificar o processamento de respostas
- Extensa documentação e exemplos práticos

## Instalação

Para começar a usar a iblioteca _**pagbank-dotnet**_, siga estas etapas simples:

1. Abra seu projeto .NET no Visual Studio ou em sua IDE preferida.
2. Use o Gerenciador de Pacotes NuGet para adicionar a biblioteca ao seu projeto:

```bash
Install-Package pagbank-dotnet
```
## Documentação Oficial do PagBank

Para informações detalhadas sobre como usar a biblioteca _**pagbank-dotnet**_ em conjunto com as APIs do PagBank, consulte a nossa [Documentação Oficial](https://dev.pagbank.uol.com.br/reference/introducao).


## Exemplo de uso

```c#
using PagBank;
var client = new PagBankClient();
client.WithBaseUrl(BaseUrl.Sandbox);
client.WithMethod(PagBankMethod.Get);
client.WithToken("your-token");
client.WithResource("{seu_recurso}");
```

#### Exemplo de criar o pedido

```c#
var body = new PagBankBody
{
Customer = new Customer
{
TaxId = "62046100077",
Email = "[email protected]",
Name = "Test"
},
ReferenceId = "1234"
};
client.WithBaseUrl(BaseUrl.Sandbox);
client.WithMethod(PagBankMethod.Post);
client.WithJsonBody(body);
client.WithToken("your-token");
client.WithResource("orders");
var response = await client.ExecuteAsync();
```

#### Exemplo de consultar pedidos

```c#
client.WithBaseUrl(BaseUrl.Sandbox);
client.WithMethod(PagBankMethod.Get);
client.WithToken("your-token");
client.WithResource("orders/ORDE_XXXXXXXX");
var response = await client.ExecuteAsync();
```

## Testes Unitários Compatíveis

A biblioteca _**pagbank-dotnet**_ é compatível e funcional com testes unitários usando a biblioteca de mocking Moq. Isso permite que você crie testes robustos para garantir a qualidade e a estabilidade da sua aplicação.

Veja um [exemplo](https://github.com/matmiranda/pagbank-dotnet/blob/main/PagBankTest/UnitTest1.cs) de como você pode testar um serviço utilizando Moq.

## Saiba mais

Para mais detalhes e exemplos detalhados, consulte nossa [Wiki](https://github.com/matmiranda/pagbank-dotnet/wiki).


## Contribua e Ajude a Melhorar

Nós valorizamos sua contribuição para tornar a biblioteca _**pagbank-dotnet**_ ainda melhor!

Se você encontrar erros, problemas ou tiver ideias para melhorias, fique à vontade para:

- Abrir problemas (Issues) detalhados para relatar erros ou propor melhorias.
- Enviar pull requests (PRs) com suas contribuições e correções.
- Participar de discussões construtivas sobre o projeto.

Sua ajuda é fundamental para o sucesso contínuo da biblioteca!

0 comments on commit 3b8ead3

Please sign in to comment.