Huw Campbell
a122b646ad
Explain one common misusage pattern
2017-02-03 10:14:59 +11:00
Huw Campbell
54cb2923ea
Take in Feedback on README
2017-02-03 10:14:04 +11:00
Huw Campbell
c050e30495
Style
2016-12-01 22:04:13 +11:00
Huw Campbell
e0b9e89cef
Update README and hello example
2016-11-25 12:38:06 +11:00
Huw Campbell
d015cd9255
Add additional doc
2016-11-24 22:58:01 +11:00
Paolo Capriotti
985d683b37
Fixed name of target option.
2016-11-24 22:55:57 +11:00
Paolo Capriotti
ac74b58447
Restore badges in the README
2016-11-24 22:55:57 +11:00
Paolo Capriotti
8de333d2ae
Replace README with documentation
2016-11-24 22:55:57 +11:00
Steven(Yuhang) Wang
23f15d262f
fix missing imports in README.md
...
fix missing imports in the example from the README.md
2016-10-17 21:18:42 +11:00
Justus Adam
81bd89a1d7
Using showDefault
2016-10-15 12:19:02 +02:00
Justus Adam
40312787bc
Aligning record fields
2016-10-14 10:17:09 +02:00
Justus Adam
761b8fe366
Added short flag and Int argument
2016-10-14 10:12:14 +02:00
Niklas Hambüchen
6e1e21037f
README: Add example for default values
2016-09-17 01:07:56 +02:00
Huw Campbell
fd4b87eda1
Update README.md
2016-08-10 11:34:40 +10:00
Huw Campbell
9b7539183d
Update Readme's description of parseFluxCapacitor to use eitherReader
2016-08-09 10:47:09 +10:00
Paolo Capriotti
43d0275fe3
Move import statement into sample parser code block
2014-10-12 11:10:11 +01:00
Ryan Mulligan
dd71eeb072
Add quick installation and import instructions
2014-10-12 11:09:38 +01:00
Paolo Capriotti
c0aa50a3e5
Update documentation of readers
2014-10-05 17:14:54 +01:00
Paolo Capriotti
b278f71bb7
Add table of contents to README.md
2014-09-24 00:09:25 +01:00
Paolo Capriotti
a64910cb5c
Add hackage badge and use svg badge for travis
2014-09-22 00:25:09 +01:00
Paolo Capriotti
f19b5ef37e
Point to latest hackage page
2014-09-01 10:37:21 +01:00
Paolo Capriotti
9091b1156f
Make option
take the reader as a parameter ( fixes #63 )
...
This commit implements the plan described in the ticket:
- the `reader` modifier is gone, as well as the `optReader` field of
`OptionFields`
- `option` now takes the reader as argument
- `nullOption` is now deprecated in favour of `option`
- added `strArgument` as a synonym for `argument str`, to mirror `strOption`
2014-08-25 18:38:28 +01:00
Anders Claesson
c85bd49e4e
Fix a few small issues with the documentation
2014-08-06 17:13:09 +01:00
Paolo Capriotti
0cf548007d
Remove old link in README.
2014-07-23 14:27:04 +01:00
Paolo Capriotti
a6090e5d99
Link to documentation of Disambiguation ( fixes #83 ).
2014-07-23 14:20:03 +01:00
Paolo Capriotti
cf9bbb538e
Document metavars ( fixes #86 ).
2014-07-23 12:43:32 +01:00
Jakub Stasiak
7b550b99af
Link to Hackage page and builder documentation
2014-06-16 00:29:34 +01:00
Paolo Capriotti
36c3f9e219
Links to wiki pages.
2013-12-21 15:49:44 +00:00
Paolo Capriotti
d4b00975a4
Deprecate arguments
and arguments1
.
2013-10-24 10:37:53 +01:00
Paolo Capriotti
b09fb36f4b
Update README.
...
Explain argument parsing policy and the special treatment of --.
2013-10-17 18:07:04 +01:00
Paolo Capriotti
07a94c15cf
Fix typos in README.md.
2013-10-17 11:52:00 +01:00
Paolo Capriotti
2b1cb0c683
Update custom reader example in the README ( fixes #41 ).
2013-03-17 18:56:56 +00:00
Paolo Capriotti
8fdc854b42
Improve docs for the Arrow
interface ( fixes #26 ).
...
Document the fact that the `Arrow` interface does not add
expressiveness to the library.
2012-12-23 18:35:47 +00:00
Paolo Capriotti
e7cc1568c5
Add example of using the 'optional' combinator ( fixes #25 ).
2012-12-23 17:21:02 +00:00
Paolo Capriotti
50e1014c6a
Add example for flag' ( fixes #34 ).
2012-12-23 17:13:33 +00:00
Paolo Capriotti
cb9af6b8b8
Remove all mentions to (&) from the README ( #37 ).
2012-12-22 12:21:23 +00:00
Paolo Capriotti
45d3954d77
Replace (&) with (<>) in the README ( #37 ).
2012-12-22 12:14:54 +00:00
Paolo Capriotti
b23c57bd20
Update docs after error handling changes.
2012-12-22 11:07:47 +00:00
Paolo Capriotti
091508459e
Replace "Common" with "Available" in help text.
...
"Common options" was intended as "all except internal", but it could be
interpreted as "global options" for a parser with commands.
Remove the possible confusion by using "Available options" instead,
which is also consistent with the label used for commands.
2012-07-30 19:13:13 +01:00
Paolo Capriotti
185a7d4af9
Revisit "commands" section in the tutorial.
...
Fix `subparser` example, and add alternative style with parsers
returning `IO` actions.
2012-07-30 18:46:01 +01:00
Paolo Capriotti
96e1d42cdd
Fix typos in README.
2012-07-30 18:35:42 +01:00
Paolo Capriotti
53e780f819
Update builder documentation.
2012-07-23 00:58:49 +01:00
Paolo Capriotti
11f93c230e
Fix typo in README.
2012-07-21 00:51:38 +01:00
Paolo Capriotti
e4aa8b81ad
Tweak README.
2012-07-21 00:51:05 +01:00
Paolo Capriotti
e4a4d5402c
Add a README paragraph about the arrow interface.
2012-07-20 22:51:46 +01:00
Paolo Capriotti
4bee34ad4f
Fix greet function in Hello example.
2012-06-11 22:42:45 +01:00
Paolo Capriotti
a2ba8bd30e
Add syntax highlighting to README.md.
2012-06-09 00:58:06 +01:00
Paolo Capriotti
284b20348f
Add Travis CI configuration and status.
2012-06-08 23:14:26 +01:00
Paolo Capriotti
36547475bf
Update usages of info
in the documentation.
...
The documentation was still using the old syntax for specifying a
`ParserInfo`.
2012-06-08 21:40:10 +01:00
Michael Thompson
6a29e323b1
wrong link to your blogpost
2012-05-17 16:54:04 +02:00