Add icon and readme

This commit is contained in:
nicolas.dorier 2023-10-04 18:59:03 +09:00
parent 5b67d1aa15
commit 14dedc14ac
No known key found for this signature in database
GPG Key ID: 6618763EF09186FE
5 changed files with 50 additions and 5 deletions

BIN
BTCPayServer.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.0 KiB

35
README.md Normal file
View File

@ -0,0 +1,35 @@
# BTCPayServer.BoltCardTools
## Introduction
This repository hosts tools that help with the creation of [Bolt Cards](https://boltcard.org/).
## Examples
Plug in a smart card reader, such as the [identiv utrust 3700 f](https://www.identiv.com/products/logical-access-control/smart-card-readers-writers/contactless-smart-card-readers-writers/3700f), and place an NTag 424 smart card on it.
Reference the nuget package [BTCPayServer.NTag424.PCSC](https://www.nuget.org/packages/BTCPayServer.NTag424.PCSC) in your project.
```bash
dotnet add package BTCPayServer.NTag424.PCSC
```
Then to use it:
```csharp
using BTCPayServer.NTag424.PCSC;
using System;
using var ctx = PCSCContext.Create();
var ntag424 = ctx.CreateNTag424();
var key = AESKey(new byte[16]);
await ntag.AuthenticateEV2First(0, key);
var id = ntag.GetCardUID();
var idStr = Convert.ToHexString(id, 0, id.Length).ToLowerInvariant();
Console.WriteLine($"Card UID: {idStr}");
```
## License
MIT

View File

@ -17,11 +17,11 @@
<PropertyGroup>
<Copyright>Copyright © BTCPay Server 2017</Copyright>
<Description>A library to communicate with NTag 424 chips and assist BoltCard creation</Description>
<PackageIcon>../../BTCPayServer.png</PackageIcon>
<PackageIcon>BTCPayServer.png</PackageIcon>
<PackageTags>ntag424,rfid</PackageTags>
<PackageProjectUrl>https://github.com/btcpayserver/BTCPayServer.BoltCardTools/</PackageProjectUrl>
<RepositoryUrl>https://github.com/btcpayserver/BTCPayServer.BoltCardTools/</RepositoryUrl>
<PackageReadmeFile>https://github.com/btcpayserver/BTCPayServer.BoltCardTools/Readme.md</PackageReadmeFile>
<PackageReadmeFile>README.md</PackageReadmeFile>
<PackageLicenseExpression>MIT</PackageLicenseExpression>
<RepositoryType>git</RepositoryType>
</PropertyGroup>
@ -33,4 +33,9 @@
<PackageReference Include="Microsoft.SourceLink.GitHub" Version="1.1.1" PrivateAssets="All"/>
</ItemGroup>
<ItemGroup>
<None Include="..\..\BTCPayServer.png" Pack="true" PackagePath="\"/>
<None Include="..\..\README.md" Pack="true" PackagePath="\"/>
</ItemGroup>
</Project>

View File

@ -2,7 +2,7 @@ using System.Buffers;
using PCSC;
using PCSC.Extensions;
namespace BTCPayServer.NTag424;
namespace BTCPayServer.NTag424.PCSC;
public class PCSCAPDUTransport : IAPDUTransport
{

View File

@ -11,11 +11,11 @@
<PropertyGroup>
<Copyright>Copyright © BTCPay Server 2017</Copyright>
<Description>A library to communicate with NTag 424 chips and assist BoltCard creation</Description>
<PackageIcon>../../BTCPayServer.png</PackageIcon>
<PackageIcon>BTCPayServer.png</PackageIcon>
<PackageTags>ntag424,rfid</PackageTags>
<PackageProjectUrl>https://github.com/btcpayserver/BTCPayServer.BoltCardTools/</PackageProjectUrl>
<RepositoryUrl>https://github.com/btcpayserver/BTCPayServer.BoltCardTools/</RepositoryUrl>
<PackageReadmeFile>https://github.com/btcpayserver/BTCPayServer.BoltCardTools/Readme.md</PackageReadmeFile>
<PackageReadmeFile>README.md</PackageReadmeFile>
<PackageLicenseExpression>MIT</PackageLicenseExpression>
<RepositoryType>git</RepositoryType>
</PropertyGroup>
@ -33,4 +33,9 @@
<PackageReference Include="Microsoft.SourceLink.GitHub" Version="1.1.1" PrivateAssets="All" />
</ItemGroup>
<ItemGroup>
<None Include="..\..\BTCPayServer.png" Pack="true" PackagePath="\"/>
<None Include="..\..\README.md" Pack="true" PackagePath="\"/>
</ItemGroup>
</Project>