Skip to content

Commit 0412d09

Browse files
committed
Improve README.md
- Add kotlin-argparser-example link - Make Forcing Parsing section a bit mor explicit - replace "Credits" section with "Thanks" section. Git(hub) already keeps track of contributors -- don't create unnecessary work for everyone.
1 parent 6e16f03 commit 0412d09

File tree

1 file changed

+21
-10
lines changed

1 file changed

+21
-10
lines changed

README.md

Lines changed: 21 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -364,24 +364,27 @@ And equally easy to create a program that behaves like `cp`:
364364

365365
## Forcing Parsing
366366

367-
It is possible to enforce the parsing of arguments into a class of values. This
368-
ensures that all arguments that are required are provided, and all arguments
369-
provided are consumed. Forcing can be done in separate steps:
367+
Parsing normally does not begin until a delegate's value is accessed. Sometimes
368+
this is not desirable, so it is possible to enforce the parsing of arguments
369+
into a class of values. This ensures that all arguments that are required are
370+
provided, and all arguments provided are consumed.
371+
372+
Forcing can be done in a separate step using the `force` method:
370373

371374
```kotlin
372375
val parser = ArgParser(args)
373376
val parsedArgs = ParsedArgs(parser)
374377
parser.force()
375378
// now you can use parsedArgs
376379
```
377-
378-
Alternatively forcing of parsing and validation can be done inline:
380+
381+
Alternatively, forcing can be done inline via the `parseInto` method:
379382

380383
```kotlin
381384
val parsedArgs = ArgParser(args).parseInto(::ParsedArgs)
382385
// now you can use parsedArgs
383386
```
384-
387+
385388
In both cases exceptions will be thrown where parsing or validation errors are found.
386389

387390
## Help Formatting
@@ -452,7 +455,7 @@ constructing a `HelpFormatter` instance. In the above example a
452455
reasonably easy to avoid.
453456

454457

455-
## Configuring your Build
458+
## Configuring Your Build
456459

457460
Kotlin-argparser binaries are hosted on Bintray's JCenter. In Gradle, use
458461
something like this in your `build.gradle`:
@@ -473,11 +476,19 @@ dependencies can be found under the "Maven build settings" heading on
473476
page](https://bintray.com/xenomachina/maven/kotlin-argparser/_latestVersion),
474477
as well as the version of the latest release.
475478

479+
## A Complete Example
476480

477-
## Credits
481+
See [kotlin-argparser-example](https://github.com/xenomachina/kotlin-argparser-example)
482+
for a complete example of how to use Kotlin-argparser.
478483

479-
This library was created by [Laurence Gonsalves](http://laurence.gonsalv.es).
484+
## Thanks
480485

481-
I'd also like to thank the creators of Python's
486+
Thanks to the creators of Python's
482487
[`argparse`](https://docs.python.org/3/library/argparse.html) module, which
483488
provided the initial inspiration for this library.
489+
490+
Thanks also to the team behind [Kotlin](https://kotlinlang.org/).
491+
492+
Finally, thanks to all of the
493+
[contributors](https://github.com/xenomachina/kotlin-argparser/graphs/contributors)
494+
and folks who have contributed [issues](https://github.com/xenomachina/kotlin-argparser/issues).

0 commit comments

Comments
 (0)