Skip to content
This repository has been archived by the owner on Jul 16, 2023. It is now read-only.

Commit

Permalink
Final cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
Zarthus committed Jan 2, 2019
1 parent 7967119 commit 0458158
Show file tree
Hide file tree
Showing 5 changed files with 30 additions and 18 deletions.
15 changes: 15 additions & 0 deletions .editorconfig
@@ -0,0 +1,15 @@
# EditorConfig helps developers define and maintain consistent
# coding styles between different editors and IDEs
# editorconfig.org

root = true

[*]
indent_style = space
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true

[*.md]
trim_trailing_whitespace = false
1 change: 0 additions & 1 deletion .travis.yml
Expand Up @@ -19,7 +19,6 @@ matrix:
notifications:
email: false


before_cache: |
if [[ "$TRAVIS_RUST_VERSION" == nightly ]]; then
RUSTFLAGS="--cfg procmacro2_semver_exempt" cargo install cargo-tarpaulin
Expand Down
11 changes: 11 additions & 0 deletions CHANGELOG.md
@@ -0,0 +1,11 @@
# 0.1.1

This is a non-breaking release, the API has not been changed.

Improvements to:

- code coverage (more tests)
- code style (editorconfig introduction)
- code (removes cargo warnings)
- documentation (readme, docblocks, Cargo.toml fixes)
- infrastructure (ci setup)
5 changes: 4 additions & 1 deletion Cargo.toml
@@ -1,6 +1,6 @@
[package]
name = "opentdb"
description = "An implementation of the Open Trivia Database API in Rust <https://opentdb.com>"
description = "An implementation of the Open Trivia Database API in Rust https://opentdb.com.\n"
repository = "https://github.com/zarthus/opentdb-rs"
version = "0.2.0"
authors = ["Jos Ahrens <contact@liefland.net>"]
Expand All @@ -10,8 +10,11 @@ keywords = ["trivia", "otdb", "open-trivia"]
categories = ["api-bindings", "games"]

[badges]
codecov = { repository = "zarthus/opentdb-rs", branch = "master", service = "github" }
travis-ci = { repository = "zarthus/opentdb-rs", branch = "master" }
maintenance = { status = "passively-maintained" }
is-it-maintained-open-issues = { repository = "zarthus/opentdb-rs" }
is-it-maintained-issue-resolution = { repository = "zarthus/opentdb-rs" }

[dependencies]
reqwest = "0.9.5"
Expand Down
16 changes: 0 additions & 16 deletions README.md
Expand Up @@ -59,22 +59,6 @@ fn main() {
- Only 1 Category can be requested per API Call. To get questions from any category, don't specify a category.
- A Maximum of 50 Questions can be retrieved per call.

### Missing

The following API lookups are not implemented:

Category Lookup: Returns the entire list of categories and ids in the database.

- https://opentdb.com/api_category.php

Category Question Count Lookup: Returns the number of questions in the database, in a specific category.

- https://opentdb.com/api_count.php?category=CATEGORY_ID_HERE

Global Question Count Lookup: Returns the number of ALL questions in the database. Total, Pending, Verified, and Rejected.

- https://opentdb.com/api_count_global.php

### License and Acknowledgements

OpenTDB itself is licensed under the [MIT license](LICENSE)
Expand Down

0 comments on commit 0458158

Please sign in to comment.