Options should be documented in the readme #13

Closed
muescha opened this Issue Oct 5, 2012 · 7 comments

Projects

None yet

3 participants

@muescha

it would be nice if all options for each letters are documented in the readme

why:
as i see it for the kill command the max options is also importent, but not documented

@davejacobs
Owner

The API options are outlined in the documentation, have you checked that out? READMEs are traditionally short and to the point, with installation and overview information. Does that make sense? I am certainly considering beefing up the README a little this weekend, but I'm not sure it needs full API information.

The k command you mention is not yet pushed to RubyGems so I haven't updated the documentation.

@muescha

Ok. But it should have a notice that there are options (like a short reference cheet sheet) with a link below the list to see an explanation for each option

@davejacobs
Owner

That's a great idea. I think I should have time for that this weekend.

@davejacobs
Owner

That's a great idea. I think I should have time for that this weekend.

@muescha muescha added a commit to muescha/letters that referenced this issue Oct 6, 2012
@muescha muescha Update README.md
beautify readme #13
c4bd981
@muescha muescha referenced this issue Oct 6, 2012
Closed

Update README.md #14

@muescha

PS: just delete not wanted style from pull request ...

on api documentation page please add a name tag so links point directly to the section

(maybe include the documentation page also in this github repo)

@blambeau

IMHO the first table, mostly because it allows jou to jump to the API for each letter.

@davejacobs davejacobs added a commit that referenced this issue Oct 6, 2012
@muescha muescha Update README.md
beautify readme #13
c7d9466
@davejacobs
Owner

This is great, just merged. FYI, the API headers all have ids (generated in JS) so your fragment links already work.

@davejacobs davejacobs closed this Oct 6, 2012
@davejacobs davejacobs was assigned Oct 6, 2012
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment