Skip to content

Commit fe16fb4

Browse files
authored
docs: udpate docs (#269)
1 parent 32f0a7f commit fe16fb4

File tree

1 file changed

+17
-2
lines changed

1 file changed

+17
-2
lines changed

README.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,27 @@
22

33
![Build Status](https://github.com/elementsinteractive/twyn/actions/workflows/test.yml/badge.svg)
44
[![PyPI version](https://img.shields.io/pypi/v/twyn)](https://pypi.org/project/twyn/)
5-
[![Python Version](https://img.shields.io/pypi/pyversions/twyn?logo=python&logoColor=yellow)](https://pypi.org/project/twyn/)
6-
![Code style](https://img.shields.io/badge/code%20style-black-000000.svg)
5+
[![Python Version](https://img.shields.io/badge/python-3.9%20%7C%203.10%20%7C%203.11%20%7C%203.12%20%7C%203.13-blue?logo=python&logoColor=yellow)](https://pypi.org/project/twyn/)
6+
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
77
[![License](https://img.shields.io/github/license/elementsinteractive/twyn)](LICENSE)
88

99
![](https://github.com/elementsinteractive/twyn/blob/main/assets/twyn.gif)
1010

11+
## Table of Contents
12+
13+
- [Overview](#overview)
14+
- [Quickstart](#quickstart)
15+
- [Installation](#installation)
16+
- [Docker](#docker)
17+
- [Run](#run)
18+
- [Configuration](#configuration)
19+
- [Allowlist](#allowlist)
20+
- [Dependency files](#dependency-files)
21+
- [Check dependencies introduced through the CLI](#check-dependencies-introduced-through-the-cli)
22+
- [Selector method](#selector-method)
23+
- [Configuration file](#configuration-file)
24+
25+
## Overview
1126
Twyn is a security tool that compares the name of your dependencies against a set of the most popular ones,
1227
in order to determine if there is any similarity between them, preventing you from using a potentially illegitimate one.
1328
In short, Twyn protects you against [typosquatting attacks](https://en.wikipedia.org/wiki/Typosquatting).

0 commit comments

Comments
 (0)