Skip to content

Commit d6dfac8

Browse files
committed
Update README.md
1 parent 7437651 commit d6dfac8

File tree

2 files changed

+13
-10
lines changed

2 files changed

+13
-10
lines changed

DOCUMENTATION.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Documentation
2+
All project features are divided into topics and fully documented.
3+
4+
There are the following topics:
5+
- [Optional arguments](Docs/OptionalArguments.md)
6+
- [Optional arguments config](Docs/OptionalArgumentsConfig.md)
7+
- [Custom converters](Docs/CustomConverters.md)
8+
- [Subcommands](Docs/Subcommands.md)
9+
- [Printing help](Docs/PrintingHelp.md)
10+
- [Additional features](Docs/AdditionalFeatures.md)
11+
- [Connect project](Docs/ConnectProject.md)

README.md

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
<a href="https://github.com/yakovypg/NetArgumentParser/blob/main/LICENSE">
88
<img src="https://img.shields.io/badge/License-GPLv3-darkyellow.svg" alt="license" />
99
</a>
10-
<img src="https://img.shields.io/badge/Version-0.0.2-red.svg" alt="version" />
10+
<img src="https://img.shields.io/badge/Version-1.0.0-red.svg" alt="version" />
1111
<img src="https://img.shields.io/badge/C%23-.NET 8-blue" />
1212
</p>
1313

@@ -67,15 +67,7 @@ You can find instructions for connecting **NetArgumentParser** to your project [
6767
- Add NuGet package.
6868

6969
## Documentation
70-
You can find documentation in the [Docs](Docs) folder.
71-
72-
The main topics are:
73-
- [Optional arguments](Docs/OptionalArguments.md)
74-
- [Optional arguments config](Docs/OptionalArgumentsConfig.md)
75-
- [Custom converters](Docs/CustomConverters.md)
76-
- [Subcommands](Docs/Subcommands.md)
77-
- [Printing help](Docs/PrintingHelp.md)
78-
- [Additional features](Docs/AdditionalFeatures.md)
70+
You can read our documentation in the [DOCUMENTATION.md](DOCUMENTATION.md).
7971

8072
## Development
8173
The project is developed on the .NET 8.0 platform. To continue development you will need the .NET SDK and .NET Runtime of the appropriate version.

0 commit comments

Comments
 (0)