modifying Readme.md

This commit is contained in:
Eefret 2014-09-21 14:16:13 -04:00
parent 39b4717293
commit 1865c16ea0

View file

@ -1,4 +1,33 @@
go-imdb
The Open Movie Database API
=======
Imdb API in golang
Author: Christopher T. Herrera (eefretsoul AT gmail DOT com)
This API uses the [omdbapi.com](http://omdbapi.com/) API by Brian Fritz
***
### OMDBAPI.com
This is an excellent open database for movie and film content.
I *strongly* encourage you to check it out and contribute to keep it growing.
### http://www.omdbapi.com
***
Project Usage
-------------
The API usage is very simple. Just import the go-imdb package
import (
imdb "github.com/eefret/go-imdb"
)
And use any of the methods
res, err := imdb.SearchMovies("The fifth element", "")
res2, err := imdb.GetMovieByTitle("True Grit", "1969")
res3, err := imdb.GetMovieByImdbId("tt2015381")
See the project documentation to see the Response Objects and stuff
Project Documentation
---------------------
The automatically generated documentation can be found in [godocs](http://godoc.org/github.com/eefret/go-imdb)