Skip to content

Commit c38b814

Browse files
committed
docs: fixed CI badge, added better summary of contained modules
1 parent 6ba8f97 commit c38b814

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

README.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,21 @@
11
aw-core
22
=======
33

4-
[![Build Status Travis](https://travis-ci.org/ActivityWatch/aw-core.svg?branch=master)](https://travis-ci.org/ActivityWatch/aw-core)
5-
[![Build Status Appveyor](https://ci.appveyor.com/api/projects/status/h5cvxoghh1wr4ycr/branch/master?svg=true)](https://ci.appveyor.com/project/ErikBjare/aw-core/branch/master)
6-
[![codecov](https://codecov.io/gh/ActivityWatch/aw-core/branch/master/graph/badge.svg)](https://codecov.io/gh/ActivityWatch/aw-core)
4+
[![GitHub Actions badge](https://github.com/ActivityWatch/aw-core/workflows/Build/badge.svg)](https://github.com/ActivityWatch/aw-core/actions)
5+
[![Code coverage](https://codecov.io/gh/ActivityWatch/aw-core/branch/master/graph/badge.svg)](https://codecov.io/gh/ActivityWatch/aw-core)
6+
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
7+
[![Typechecking: Mypy](http://www.mypy-lang.org/static/mypy_badge.svg)](http://mypy-lang.org/)
78

89

910
Core library for ActivityWatch.
1011

1112

12-
## Contents
13+
## Modules
1314

14-
- Models
15-
- Schemas
16-
- Filtering algorithms for sensitive data
15+
- `aw_core`, contains basic datatypes and utilities, such as the `Event` class, helpers for configuration and logging, as well as schemas for buckets, events, and exports.
16+
- `aw_datastore`, contains the datastore classes used by aw-server-python.
17+
- `aw_transform`, all event-transforms used in queries.
18+
- `aw_query`, the query-language used by ActivityWatch.
1719

1820

1921
## How to install

0 commit comments

Comments
 (0)