1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72

// Copyright 2019 Kixiron

//! # Rusty Xkcd
//!
//! [![Crates.io](https://img.shields.io/crates/v/rusty_xkcd.svg)](https://crates.io/crates/rusty_xkcd)
//! [![Docs.rs](https://docs.rs/rusty_xkcd/badge.svg)](https://docs.rs/rusty_xkcd)
//! [![GitLab](https://img.shields.io/badge/GitLab-Mirror-Orange.svg)](https://gitlab.com/Kixiron/rusty_xkcd)
//! [![Travis CI](https://img.shields.io/travis/Kixiron/rusty_xkcd.svg?branch=master&label=Travis%20build)](https://travis-ci.org/Kixiron/rusty_xkcd)
//! [![GitLab CI](https://img.shields.io/gitlab/pipeline/kixiron/rusty_xkcd.svg?branch=master&label=GitLab%20build)](https://gitlab.com/Kixiron/rusty_xkcd/pipelines)
//! [![License](https://img.shields.io/github/license/kixiron/rusty_xkcd.svg)](https://github.com/Kixiron/rusty_xkcd/blob/master/LICENSE)
//! [![Language](https://img.shields.io/github/languages/top/kixiron/rusty_xkcd.svg)](https://github.com/Kixiron/rusty_xkcd)
//! [![Pull Requests](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/Kixiron/rusty_xkcd/pull/new/master)
//!
//! Rusty Xkcd is an API wrapper for the [Xkcd API](https://xkcd.com/json.html).
//! It aims to give full access to the Xkcd API with maximum performance,
//! control, and reliability.
//!
//! ## Xkcd Comics
//!
//! Using rusty_xkcd to interact with the xkcd api is easy!
//!
//! To start, add this line to your `Cargo.toml`
//! ```toml
//! [dependencies]
//! rusty_xkcd = "0.1.2"
//! ```
//!
//! Then import the crate to wherever you want to use it
//!
//! ```rust
//! extern crate rusty_xkcd;
//! use rusty_xkcd::Comic;
//! ```
//!
//! Now you're ready to start using the `Comic` API!  
//! To get the latest xkcd comic, use `get_latest_comic()`
//!
//! ```rust
//! # extern crate rusty_xkcd;
//! # use rusty_xkcd::Comic;
//! let comic = Comic::get_latest_comic().unwrap();
//! ```
//!
//! To get a comic by number, use `get_comic()`
//!
//! ```rust
//! # extern crate rusty_xkcd;
//! # use rusty_xkcd::Comic;
//! let comic = Comic::get_comic(100).unwrap();
//! ```
//!
//! And finally, to get a random xkcd comic, use `get_random_comic()`
//!
//! ```rust
//! # extern crate rusty_xkcd;
//! # use rusty_xkcd::Comic;
//! let comic = Comic::get_random_comic().unwrap();
//! ```
//!
//! # Coming Soon
//!
//! [Explain Xkcd](https://www.explainxkcd.com)  
//! [What If](https://what-if.xkcd.com)

#[macro_use]
extern crate quick_error;

mod errors;
pub use errors::Error;

mod comics;
pub use comics::Comic;