Skip to content

Commit

Permalink
update: readme and project description
Browse files Browse the repository at this point in the history
  • Loading branch information
artem-burashnikov committed Dec 9, 2023
1 parent bbd4edc commit bbd7c0e
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 8 deletions.
24 changes: 17 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,17 @@

## Overview

Depinspect is an utility designed to prodive insights into linux package dependencies across multiple architectures and distributions.
**Depinspect** is an utility that offers an abstraction layer which simplifies the retrieval of package-related information across different distributions and architectures.

## Features

- **Data Aggregation:** Gathers information about packages from multiple distributions and their corresponding releases.

- **Unified Access:** Provides a streamlined and unified access point for stored metadata.

- **Modular Architecture:** Employs a modular design for simpler extendability, allowing easy integration of new features.

- **CLI Support:** Includes a Command-Line Interface (CLI) for a quick overview of divergent dependencies and other relevant information.

## Table of contents

Expand Down Expand Up @@ -66,6 +76,10 @@ Open the terminal and follow these steps:

TODO

### `depinspect update`

TODO

### `depinspect diff`

This command requires two `--package` options to be specified.
Expand All @@ -76,10 +90,6 @@ TODO

TODO

### `depinspect update`

TODO

### `depinspect find-divergent`

TODO
Expand All @@ -96,9 +106,9 @@ It is helpful to see the list of available architectures and package names store
depinspect list-all ubuntu > ubuntu_available_data.txt
```

### Initialize or re-initialize the database
### Initialize or update the metadata in databases

The tool ensures that databases exist before you can query for information. You can also manually call this process (for example, in order to update the stored metadata) by running:
The metadata is stored in SQLite databases. You can manually update it by running:

```sh
depinspect update
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[tool.poetry]
name = "depinspect"
version = "0.3.0"
description = "A tool to analyze linux package dependencies across multiple distributions and architectures"
description = "A tool that aggregates metadata from various Linux distributions, offering an abstraction layer which simplifies the retrieval of package-related information."
license = "MIT"
authors = ["Artem Burashnikov <artem.burashnikov@gmail.com>"]
maintainers = ["Artem Burashnikov <artem.burashnikov@gmail.com>"]
Expand Down

0 comments on commit bbd7c0e

Please sign in to comment.