Add description and badge

pisa-engine · Apr 21, 2020 · cd4f530 · cd4f530
1 parent 0b26031
commit cd4f530
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 0 deletions.
diff --git a/Cargo.toml b/Cargo.toml
@@ -8,6 +8,7 @@ repository = "https://github.com/pisa-engine/ciff"
 readme = "README.md"
 keywords = ["ciff", "pisa"]
 documentation = "https://docs.rs/ciff"
+description = "The inverted index exchange format as defined as part of the Open-Source IR Replicability Challenge (OSIRRC) initiative"
 build = "build.rs"
 
 [[bin]]

diff --git a/README.md b/README.md
@@ -1,5 +1,7 @@
 # Common Index File Format (CIFF)
 
+![Rust](https://github.com/pisa-engine/ciff/workflows/Rust/badge.svg)
+
 ## What is CIFF?
 
 Common Index File Format [CIFF](https://github.com/osirrc/ciff/) is an inverted index exchange format as defined as part of the *Open-Source IR Replicability Challenge (OSIRRC)* initiative. The primary idea is to allow indexes to be dumped from Lucene via [Anserini](https://github.com/castorini/anserini) which can then be ingested by other search engines. This repository contains the necessary code to read the CIFF into a format which PISA can use for building (and then searching) indexes.