Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 16 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,10 @@ Pure Lua implemented git URL parsing library, e.g. the output of <code>git remot
- [Requirements](#requirements)
- [Features](#features)
- [Install](#install)
- [Patterns](#patterns)
- [Full Pattern](#full-pattern)
- [Protocol Omitted Pattern](#protocol-omitted-pattern)
- [Local Pattern](#local-pattern)
- [API](#api)
- [Types](#types)
- [`giturlparser.GitUrlPos`](#giturlparsergiturlpos)
Expand All @@ -33,13 +37,22 @@ Pure Lua implemented git URL parsing library, e.g. the output of <code>git remot

## Features

Single file & zero dependency.
* Single file & zero dependency.
* Full [Git Protocols](https://git-scm.com/book/en/v2/Git-on-the-Server-The-Protocols) support (see [Patterns](#patterns)).

Full [Git Protocols](https://git-scm.com/book/en/v2/Git-on-the-Server-The-Protocols) support (see below).
## Install

```bash
luarocks install giturlparser
```

## Patterns

Below url patterns been supported:

> [!NOTE]
>
> Below pattern are (just easier to help explain the parsing algorithm) written in a regex-like syntax:
> These patterns are (just easier to help explain the parsing algorithm) written with a regex-like syntax:
>
> 1. The `{}` contains parsed components returned from [`giturlparser.GitUrlInfo`](#giturlparsergiturlinfo).
> 2. The `[]` contains optional (0 or 1) component.
Expand Down Expand Up @@ -82,10 +95,6 @@ For example:
- `~/home/to/the/repo.git`
- `/usr/home/to/the/repo.git`

## Install

`luarocks install giturlparser`

## API

### Types
Expand Down