A "repo" is a repository. It'= s the place where your project is stored via git, e.g. the git repository o= f fuzzy-string-match is hosted by Github and is accessible via the URL git:= //github.com/ki= yoka/fuzzy-string-match.git.

".md" is a format called Markdown, a plain text to HTML= converter meant for web usage. It's very simple and it's used in l= ots of places (e.g. Github, Stackoverflow). You can read more about in this= link: http://dari= ngfireball.net/projects/markdown/

Finally, the method `create` is used to generate an object that w= ill do the work you need, at least this is what I get from reading the READ= ME: https://github.com/kiyoka/fuzzy-string-match/blob/master/README.md<= /a>

If you have specific doubts about how to use this gem and/or want= more documentation (and you should), please create a free Github account a= nd open an issue in the issue tracker: https://github.com/kiyoka/fuzzy-string-match/is= sues

-----

Carlos Agarie

Control engineering

Polytechnic = School,=A0University of S=E3o Paulo, Brazil

Computer engineering<= /div>

Embry-Riddle Aeronautical University, USA

2013/1/1 John Sampson = <jrs.idx@ntlwo= rld.com>

On 01/01/2013 15:13, tamouse mailing lists wrote:

On Tue, Jan 1, 2013 at 8:29 AM, John Sampson <jrs.idx@ntlworld.com> wrote:

The issue is that I don't know how to read the documentation. Where, or= how,
does it show how to
call the methods? I would have thought there would be a general description=
somewhere explaining
the structure of Github or Gem documentation.

Github is way beyond the scope of a single gem to describe.

The README.md file in the repo pointed at by Mateusz shows how to make
the calls in the Sample Code section.

If the README.md file had been written as a README.rdoc, it would have
been included in the gem rdocs. That doesn't seem to be much in
practice any more as most people go to Github to find gems. Not sure
what to do about it.

So README.md is where one looks, and it is in the 'repo', whatever = that is. I see that
the method ".create" is a combination of ".new" and &qu= ot;.save" - What does ".save" do?
For idle curiosity, what does ".md" mean? What are rdocs for? Are= they no longer
useful?