Skip to content

Commit 3b396d4

Browse files
authored
Merge pull request #86 from hsaito/doc-update
Update README.md to enhance project descriptions and usage examples
2 parents a3c7d9c + 5ac333d commit 3b396d4

1 file changed

Lines changed: 46 additions & 7 deletions

File tree

README.md

Lines changed: 46 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,54 @@
11
# My Number Library for .NET
22

3-
This library facilitates validation of the [My Number](http://www.cao.go.jp/bangouseido/), also known as Social Security and Tax Number System.
3+
This repository provides tools for validating and generating Japanese My Number (Social Security and Tax Number System) in .NET.
44

5-
## MyNumber.NET
5+
## Projects
66

7-
A library to validate the My Number.
7+
### MyNumberNET
8+
A .NET library for validating and generating My Number sequences.
89

9-
## MyNumber.NET_CLI
10+
**Features:**
11+
- Validate a 12-digit My Number: `MyNumber.VerifyNumber(int[] number)`
12+
- Calculate check digit for first 11 digits: `MyNumber.CalculateCheckDigits(int[] number)`
13+
- Exception handling for malformed input
1014

11-
A CLI interface that calls *MyNumber.NET*.
15+
**Example Usage:**
16+
```csharp
17+
using MyNumberNET;
18+
int[] number = {6,1,4,1,0,6,5,2,6,0,0,0};
19+
bool isValid = MyNumber.VerifyNumber(number);
20+
```
1221

13-
## MyNumber.NET_Test
22+
### MyNumberNET_CLI
23+
A command-line interface for validating and generating My Numbers.
1424

15-
Unit test for the above.
25+
**Usage:**
26+
```
27+
dotnet run --project MyNumberNET_CLI [command] [arguments]
28+
```
29+
**Commands:**
30+
- `generate [count]` : Generate valid My Numbers
31+
- `check [My Number]` : Validate a given number
32+
- `complete [first 11 digits]` : Complete a number by calculating the check digit
33+
- `rangen [min] [max]` : Generate numbers in a numerical range
34+
- `ranges [min] [max]` : Generate numbers in a sequential range
35+
36+
### MyNumberNET_Test
37+
Unit tests for the library.
38+
39+
**To run tests:**
40+
```
41+
dotnet test MyNumberNET_Test
42+
```
43+
44+
## Build Instructions
45+
46+
1. Clone the repository.
47+
2. Build the solution:
48+
```
49+
dotnet build MyNumberNET.sln
50+
```
51+
3. Run CLI or tests as shown above.
52+
53+
## License
54+
See LICENSE for details.

0 commit comments

Comments
 (0)