1
0
mirror of https://github.com/ilri/dspace-statistics-api.git synced 2024-12-22 12:42:19 +01:00

README.md: Improve introduction

This commit is contained in:
Alan Orth 2018-11-01 00:08:24 +02:00
parent 10c1f8bdcc
commit 77194707fd
Signed by: alanorth
GPG Key ID: 0FB860CC9C45B1B9

View File

@ -1,5 +1,7 @@
# DSpace Statistics API [![Build Status](https://travis-ci.org/ilri/dspace-statistics-api.svg?branch=master)](https://travis-ci.org/ilri/dspace-statistics-api)
A simple REST API to expose Solr view and download statistics for items in a DSpace repository. This project contains an indexing component and a WSGI application. The Solr queries used to gather the statistics in this project were modeled on those found on the [DSpace wiki](https://wiki.duraspace.org/display/DSPACE/Solr).
DSpace versions 4.0 and up include a [REST API](https://wiki.duraspace.org/display/DSDOC5x/REST+API) that allows the repository to be queried programmatically. The API exposes information about communities, collections, items, and bitstreams, but not item views or downloads. This project contains a lightweight indexer and a web application to make the view and download statistics available via a simple REST API that can be deployed simultaneously with DSpace's own.
You can read more about the Solr queries used to gather the item view and download statistics on the [DSpace wiki](https://wiki.duraspace.org/display/DSPACE/Solr).
## Requirements