From cd4f530b2fd5c3a9a813403eb956150cd1f60b5f Mon Sep 17 00:00:00 2001 From: Michal Siedlaczek Date: Tue, 21 Apr 2020 13:14:41 -0400 Subject: [PATCH] Add description and badge --- Cargo.toml | 1 + README.md | 2 ++ 2 files changed, 3 insertions(+) diff --git a/Cargo.toml b/Cargo.toml index e8850ca..ab0e24a 100644 --- 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 index faaa168..6447e78 100644 --- 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.