Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
yakovypg committed Aug 7, 2024
1 parent 7437651 commit d6dfac8
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 10 deletions.
11 changes: 11 additions & 0 deletions DOCUMENTATION.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Documentation
All project features are divided into topics and fully documented.

There are the following topics:
- [Optional arguments](Docs/OptionalArguments.md)
- [Optional arguments config](Docs/OptionalArgumentsConfig.md)
- [Custom converters](Docs/CustomConverters.md)
- [Subcommands](Docs/Subcommands.md)
- [Printing help](Docs/PrintingHelp.md)
- [Additional features](Docs/AdditionalFeatures.md)
- [Connect project](Docs/ConnectProject.md)
12 changes: 2 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<a href="https://github.com/yakovypg/NetArgumentParser/blob/main/LICENSE">
<img src="https://img.shields.io/badge/License-GPLv3-darkyellow.svg" alt="license" />
</a>
<img src="https://img.shields.io/badge/Version-0.0.2-red.svg" alt="version" />
<img src="https://img.shields.io/badge/Version-1.0.0-red.svg" alt="version" />
<img src="https://img.shields.io/badge/C%23-.NET 8-blue" />
</p>

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

## Documentation
You can find documentation in the [Docs](Docs) folder.

The main topics are:
- [Optional arguments](Docs/OptionalArguments.md)
- [Optional arguments config](Docs/OptionalArgumentsConfig.md)
- [Custom converters](Docs/CustomConverters.md)
- [Subcommands](Docs/Subcommands.md)
- [Printing help](Docs/PrintingHelp.md)
- [Additional features](Docs/AdditionalFeatures.md)
You can read our documentation in the [DOCUMENTATION.md](DOCUMENTATION.md).

## Development
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.
Expand Down

0 comments on commit d6dfac8

Please sign in to comment.