Skip to content

Commit

Permalink
chg: [documentation] Updated README and index.rst of the documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
cedricbonhomme committed Dec 19, 2023
1 parent ce15b88 commit 25a2a4f
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 5 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,20 +6,20 @@
is a libre software which is providing a backend architecture
for collecting data from probes and storing proof of checks.

This platform is composed of:
The platform is composed of:

- a documented HTTP API with a PubSub mechansim and a connection to a
database;
- a backend to deploy and monitor a network of probes.
The architecture is relying on the
[Smart Python Agent Development Environment](https://github.com/javipalanca/spade);
- a service to timestamp the collected data with a third party
([RFC 3161](https://www.ietf.org/rfc/rfc3161.txt)) for the proof of checks;
([RFC 3161](https://www.ietf.org/rfc/rfc3161.txt)) for the proof of checks.

The API is based on the [FastAPI](https://fastapi.tiangolo.com) framework
well known for its excellent performance.

It is possibility to extend the platform in order to share data with external
It is possible to extend the platform in order to share data with external
system, such as MISP.


Expand Down
7 changes: 5 additions & 2 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Presentation
`SCANDALE <https://github.com/scandale-project/scandale>`_, is a libre software which is providing a backend architecture
for collecting data from probes and storing proof of checks (cryptographic timestamping).

This platform is composed of:
The platform is composed of:

- a documented HTTP API with a PubSub mechansim and a connection to a
database;
Expand All @@ -17,7 +17,7 @@ This platform is composed of:
- a service to timestamp the collected data with a third party
(`RFC 3161 <https://www.ietf.org/rfc/rfc3161.txt>`_) for the proof of checks.

It is possibility to extend the platform in order to share data with external
It is possible to extend the platform in order to share data with external
system, such as MISP.


Expand Down Expand Up @@ -52,3 +52,6 @@ License

SCANDALE is licensed under
`GNU Affero General Public License version 3 <https://www.gnu.org/licenses/agpl-3.0.html>`_.

- Copyright (C) 2022-2023 `Cédric Bonhomme <https://www.cedricbonhomme.org>`_
- Copyright (C) 2022-2023 `CIRCL - Computer Incident Response Center Luxembourg <https://www.circl.lu>`_

0 comments on commit 25a2a4f

Please sign in to comment.