diff --git a/README.md b/README.md index 35c3b74..412cde0 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,53 @@ [![Build Status](https://travis-ci.org/bvn13/imdb-spider.svg?branch=master)](https://travis-ci.org/bvn13/imdb-spider) -# imdb-spider -IMDB-spider written in Java +# IMDB-SPIDER + +**IMDB-spider written in Java** + +The purpose of this project is to parse IMDB site into Java objects to be easy used when it needs. + +Take a look at simple description of the [Core](core/README.md) part. It describes all the logic of parsing. + +The [Runner](runner/README.md) part aims to implement different use cases of searching movie info from CLI. + +## Dependencies + +- **Java 11** - tested +- JSoup +- com.fasterxml.jackson +- JUnit 4 + +## Plans and dones + +- `[+]` - implemented already +- `[*]` - not implemented fully yet, in development +- `[ ]` - not implemented yet, in plans + +``` + +[*] Movies + [+] Title + [+] Original title + [+] Year + [+] Poster + [+] Storyline + [+] Random tagline + [+] Genres + [+] Certificate + [+] Official sites + [+] Countries + [+] Languages + [+] Release date + [+] Budget + [+] Cumulative worldwide gross + [+] Runtime + [+] Sound mixes + [+] Color + [+] Aspect ratio + [+] Taglines + [+] AKAs + +[ ] Persons + +``` diff --git a/core/README.md b/core/README.md index 624b083..5c8f271 100644 --- a/core/README.md +++ b/core/README.md @@ -10,11 +10,15 @@ But tasks and workers would be nothing without their assistants. They are: -- [Extractors](src/main/java/ru/bvn13/imdbspider/spider/extractor) +- [Extractor](src/main/java/ru/bvn13/imdbspider/spider/extractor) - [Processors](src/main/java/ru/bvn13/imdbspider/spider/processor) - [Composers](src/main/java/ru/bvn13/imdbspider/spider/composer) +And the heart of Spider is [API](src/main/java/ru/bvn13/imdbspider/spider/api/v1_0) - the set of processors that parse IMDB html data into Tasks to be composed into [Objects](src/main/java/ru/bvn13/imdbspider/imdb/) after all. + +So... + diff --git a/runner/README.md b/runner/README.md new file mode 100644 index 0000000..720679d --- /dev/null +++ b/runner/README.md @@ -0,0 +1,6 @@ +# IMDB-SPIDER :: RUNNER + +Command Line Interface for searching movies on IMDB site. + +This part is _under constraction_. +