From d2607bc1e58d1cd0905b1d071d57eeadf04c53bf Mon Sep 17 00:00:00 2001 From: h1alexbel Date: Wed, 17 Apr 2024 18:52:13 +0300 Subject: [PATCH] chore: how to use --- README.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 8a3ebe7..00943ee 100644 --- a/README.md +++ b/README.md @@ -28,7 +28,21 @@ sample repositories. ## How to use -TBD.. +First, install it from [PyPI](https://pypi.org/project/samples-filter) like that: + +```bash +pip install samples-filter +``` + +then, execute: + +```bash +samples-filter filter --repositories=repos.csv --out=filtered.csv +``` + +For `--repositories` you should provide a name of **existing** [csv](https://en.wikipedia.org/wiki/Comma-separated_values) +dataset with GitHub repositories, and name for the output file in `--out` +(it will be created automatically). ## Filtering method