Skip to content

Commit

Permalink
Minor readme changes
Browse files Browse the repository at this point in the history
  • Loading branch information
ulitol97 committed Apr 7, 2022
1 parent fe26dd1 commit 83d2e57
Showing 1 changed file with 41 additions and 1 deletion.
42 changes: 41 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,44 @@
![comet@m](https://user-images.githubusercontent.com/35763574/159525749-830e7605-829a-4923-ab94-bd94496d24d8.png)

# comet
Scala application for validation of RDF streams with Shape Expressions

Comet is a [Scala](https://scala-lang.org/) application for
validating [RDF data](https://www.w3.org/RDF/)
streams. Comet uses:

- [Cats Effect](https://github.com/typelevel/cats-effect): For composing the app
in a functional style and within the Typelevel ecosystem
- [FS2](https://github.com/typelevel/fs2): For reliably processing all sorts of
Streams in a functional way
- [SHaclEX](https://github.com/weso/shaclex): For RDF processing and validation
against both [ShEx](https://shex.io/)
and [SHACL](https://www.w3.org/TR/shacl/)

## Downloading and installing

- Todo.
- Explain how to get the library once uploaded.
- Cross compiled versions.
- Example build.sbt adding the dependency.

## Getting started

- Todo.
- Introduce a little example in a commented main method.

## Developer info

For those who are willing to build, modify or contribute, the project uses _sbt_
, as well as:

- Java 17 (LTS)
- [Scala 3](https://docs.scala-lang.org/scala3/new-in-scala3.html)
- Cats Effect 3

## Pending explanations

- Todo. Refer to wiki/microsite for:
- Usage examples
- Validator model.
- Extractor model (extensible!).
- etc.

0 comments on commit 83d2e57

Please sign in to comment.