Commit be0cdae6 authored by Dmitry Mozzherin's avatar Dmitry Mozzherin
Browse files

add table of content for README

parent 844449dc
Pipeline #46251630 passed with stages
in 8 minutes and 26 seconds
......@@ -35,6 +35,31 @@ gnparser -f simple "Homo sapiens Linnaeus"
gnparser -h
```
- [Global Names Parser: gnparser written in Go](#global-names-parser-gnparser-written-in-go)
- [Introduction](#introduction)
- [Speed](#speed)
- [Features](#features)
- [Use Cases](#use-cases)
- [Getting the simplest possible canonical form](#getting-the-simplest-possible-canonical-form)
- [Normalizing name-strings](#normalizing-name-strings)
- [Removing authorships in the middle of the name](#removing-authorships-in-the-middle-of-the-name)
- [Figuring out if names are well-formed](#figuring-out-if-names-are-well-formed)
- [Creating stable GUIDs for name-strings](#creating-stable-guids-for-name-strings)
- [Assembling canonical forms etc. from original spelling](#assembling-canonical-forms-etc-from-original-spelling)
- [Installation](#installation)
- [Linux or OS X](#linux-or-os-x)
- [Windows](#windows)
- [Using Go tools](#using-go-tools)
- [Usage](#usage)
- [Command Line](#command-line)
- [gRPC server](#grpc-server)
- [Usage as a REST API Interface](#usage-as-a-rest-api-interface)
- [Use as a Docker image](#use-as-a-docker-image)
- [Use as a library in Go](#use-as-a-library-in-go)
- [Authors](#authors)
- [Contributors](#contributors)
- [License](#license)
## Introduction
Global Names Parser or ``gnparser`` is a program written in Go for breaking up
......
......@@ -58,7 +58,7 @@ require (
github.com/stretchr/testify v1.3.0 // indirect
go.opencensus.io v0.19.0 // indirect
go4.org v0.0.0-20181109185143-00e24f1b2599 // indirect
golang.org/x/build v0.0.0-20190201181641-63986c177d1f // indirect
golang.org/x/build v0.0.0-20190205044948-0fbf6af331f6 // indirect
golang.org/x/crypto v0.0.0-20190131182504-b8fe1690c613 // indirect
golang.org/x/exp v0.0.0-20190125153040-c74c464bbbf2 // indirect
golang.org/x/net v0.0.0-20190125091013-d26f9f9a57f3
......@@ -66,7 +66,7 @@ require (
golang.org/x/perf v0.0.0-20190124201629-844a5f5b46f4 // indirect
golang.org/x/sys v0.0.0-20190204203706-41f3e6584952 // indirect
golang.org/x/text v0.3.1-0.20180807135948-17ff2d5776d2
golang.org/x/tools v0.0.0-20190204195632-d810ce9e47b0 // indirect
golang.org/x/tools v0.0.0-20190205050122-7f7074d5bcfd // indirect
google.golang.org/genproto v0.0.0-20190201180003-4b09977fb922 // indirect
google.golang.org/grpc v1.18.0
honnef.co/go/tools v0.0.0-20190128043916-71123fcbb8fe // indirect
......
......@@ -253,6 +253,7 @@ golang.org/x/build v0.0.0-20190124033707-36bd60da6b75/go.mod h1:OWs+y06UdEOHN4y+
golang.org/x/build v0.0.0-20190128191652-269e03abe74b/go.mod h1:OWs+y06UdEOHN4y+MfF/py+xQ/tYqIWW03b70/CG9Rw=
golang.org/x/build v0.0.0-20190129203959-bace88d50da9/go.mod h1:OWs+y06UdEOHN4y+MfF/py+xQ/tYqIWW03b70/CG9Rw=
golang.org/x/build v0.0.0-20190201181641-63986c177d1f/go.mod h1:OWs+y06UdEOHN4y+MfF/py+xQ/tYqIWW03b70/CG9Rw=
golang.org/x/build v0.0.0-20190205044948-0fbf6af331f6/go.mod h1:OWs+y06UdEOHN4y+MfF/py+xQ/tYqIWW03b70/CG9Rw=
golang.org/x/crypto v0.0.0-20180904163835-0709b304e793/go.mod h1:6SG95UA2DQfeDnfUPMdvaQW0Q7yPrPDi9nlGo2tz2b4=
golang.org/x/crypto v0.0.0-20181030102418-4d3f4d9ffa16/go.mod h1:6SG95UA2DQfeDnfUPMdvaQW0Q7yPrPDi9nlGo2tz2b4=
golang.org/x/crypto v0.0.0-20181203042331-505ab145d0a9/go.mod h1:6SG95UA2DQfeDnfUPMdvaQW0Q7yPrPDi9nlGo2tz2b4=
......@@ -354,6 +355,8 @@ golang.org/x/tools v0.0.0-20190202202610-718ddee9569a h1:l5aJW4keRqzZu9Ad3NtNDTt
golang.org/x/tools v0.0.0-20190202202610-718ddee9569a/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
golang.org/x/tools v0.0.0-20190204195632-d810ce9e47b0 h1:nkN84Yt0YNBRfAvS2WmqXEk8xW2RzlhtbNx6jNfMIOg=
golang.org/x/tools v0.0.0-20190204195632-d810ce9e47b0/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
golang.org/x/tools v0.0.0-20190205050122-7f7074d5bcfd h1:Es0jGqKF2dQq+Z+0JvLFrUgmuMpgFwsFnKJQiaKEJNU=
golang.org/x/tools v0.0.0-20190205050122-7f7074d5bcfd/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
google.golang.org/api v0.0.0-20180910000450-7ca32eb868bf/go.mod h1:4mhQ8q/RsB7i+udVvVy5NUi08OU8ZlA0gRVgrF7VFY0=
google.golang.org/api v0.0.0-20181030000543-1d582fd0359e/go.mod h1:4mhQ8q/RsB7i+udVvVy5NUi08OU8ZlA0gRVgrF7VFY0=
google.golang.org/api v0.0.0-20181220000619-583d854617af/go.mod h1:4mhQ8q/RsB7i+udVvVy5NUi08OU8ZlA0gRVgrF7VFY0=
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment