Skip to content

Commit

Permalink
Switch order of index and installation sections
Browse files Browse the repository at this point in the history
  • Loading branch information
kelvinqian00 committed Oct 10, 2023
1 parent 078770c commit 0678d9b
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,12 @@ _Only Persephone, daughter of Zeus and wife of Hades, could travel between the U

A Clojure library for validating xAPI Statements against xAPI Profiles, featuring interactive CLI and webserver applications.

## Index

- [Library](doc/library.md): How to use the library/API functions
- [CLI](doc/cli.md): How to run the `validate` and `match` commands
- [Webserver](doc/server.md): How to start up and run a webserver

## Installation

Add the following to the `:deps` map in your `deps.edn` file:
Expand All @@ -17,15 +23,9 @@ com.yetanalytics/project-persephone {:mvn/version "0.9.1"}

Alternatively, to run the CLI or server as an application, you can pull a Docker image from [DockerHub](https://hub.docker.com/repository/docker/yetanalytics/persephone):
```
docker pull yetanalytics/persephone:latest`.
docker pull yetanalytics/persephone:latest.
```

## Documentation

- [Library](doc/library.md): How to use the library/API functions
- [CLI](doc/cli.md): How to run the `validate` and `match` commands
- [Webserver](doc/server.md): How to start up and run a webserver

## How It Works

Persephone performs two main tasks on [xAPI Statements](https://github.com/adlnet/xAPI-Spec/blob/master/xAPI-Data.md#20-statements): [Statement Template](https://github.com/adlnet/xapi-profiles/blob/master/xapi-profiles-structure.md#statment-templates) validation and [Pattern](https://github.com/adlnet/xapi-profiles/blob/master/xapi-profiles-structure.md#patterns) matching. The former checks if a Statement follows the specifications of one or more Statement Templates in xAPI Profiles, while the latter performs regex-like matching against Profile Patterns. Persephone does so following the [validation and matching guidelines](https://github.com/adlnet/xapi-profiles/blob/master/xapi-profiles-communication.md#20-algorithms) of the [xAPI Profile specification](https://github.com/adlnet/xapi-profiles).
Expand Down

0 comments on commit 0678d9b

Please sign in to comment.