diff options
| author | Matthias Baumgartner <dev@igsor.net> | 2023-03-01 22:05:06 +0100 |
|---|---|---|
| committer | Matthias Baumgartner <dev@igsor.net> | 2023-03-01 22:05:06 +0100 |
| commit | e0c4713c40367b4b41da926da0ba7ed05d47d54b (patch) | |
| tree | 6f224f0af22afa356be39a8852c513ed488eec17 /doc/source/index.rst | |
| parent | 365b36a30eb0afb706b706e0fa32b414f9d51a90 (diff) | |
| download | bsie-e0c4713c40367b4b41da926da0ba7ed05d47d54b.tar.gz bsie-e0c4713c40367b4b41da926da0ba7ed05d47d54b.tar.bz2 bsie-e0c4713c40367b4b41da926da0ba7ed05d47d54b.zip | |
documentation
Diffstat (limited to 'doc/source/index.rst')
| -rw-r--r-- | doc/source/index.rst | 26 |
1 files changed, 26 insertions, 0 deletions
diff --git a/doc/source/index.rst b/doc/source/index.rst new file mode 100644 index 0000000..9cf06fe --- /dev/null +++ b/doc/source/index.rst @@ -0,0 +1,26 @@ + +Black Star Information Extraction +================================= + +A major advantage of the `Black Star File System (BSFS) <https://www.bsfs.io/bsfs/>`_ +is its ability to store various kinds of (meta)data associated with a file. +However, the BSFS itself is only a storage solution, +it does not inspect files or collect information about them. + +The Black Star Information Extraction (BSIE) package fills this gap by +extracting various kinds of information from a file and pushing that data to a BSFS instance. + +BSIE has the ability to process numerous file formats, +and it can turn various aspects of a file into usable information. +This includes metadata from a source file system, +metadata stored within the file, +and even excerpts or feature representations of the file's content itself. + +.. toctree:: + :maxdepth: 1 + + installation + architecture + api/modules + + |