Make a landing page for the repository.

[raul1991]

The landing page must contain the following items

1. Playground to run the program on the fly to see what it returns
2. Self explanatory documentation.

[toshitapandey]

I'm picking this one up.

[raul1991]

Superb. Go ahead. Let me know if you need help regarding the library.

[toshitapandey]

@raul1991

1. Is the landing page supposed to be HTML thingy containing a playground for the library or do you have something else in mind?
2. Where do you expect the documentation to be?

[raul1991]

Is the landing page supposed to be HTML thingy containing a playground for the library or do you have something else in mind?

Yes the landing page would be an html page. What you can do is add another folder to the project at the root with a name doc containing the landing page.

Where do you expect the documentation to be?

The html page that you will create will explain the basic concepts and would have examples in it witha button say 'run' to run the example.

I think github uses the docs folder in the root of the project to create a documentation page for it.

https://help.github.com/articles/configuring-a-publishing-source-for-github-pages/#publishing-your-github-pages-site-from-a-docs-folder-on-your-master-branch