sinonimos

package module
v0.7.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 9, 2019 License: MIT Imports: 9 Imported by: 0

README

🇧🇷 sinonimos

CircleCI Go Report Card Go Doc Release

Find synonyms (for pt-BR) without leaving your terminal.

Preview

Installing

Run this command to download the latest version of sinonimos:

go get github.com/felipemfp/sinonimos/...

Now you're ready to use sinonimos

sinonimos --help

Hacking into sinonimos

These instructions will get you a copy of the project up and running on your local machine for development.

Prerequisites

What things you need to start hacking:

Getting started

First fork and clone the project to your machine:

git clone https://github.com/{your-username}/sinonimos.git

Then install the dependencies:

cd sinonimos
go mod download

Now you're ready to go.

For example:

go run ./cmd/sinonimos camisa

It'll run the CLI and try to find synonyms for "camisa".

Built With

Contributing

Please feel free for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE file for details

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	// ErrNotFound is returned when an expression is not found on sinonimos.com.br.
	ErrNotFound = errors.New("expression not found")
)

Functions

This section is empty.

Types

type FindInput

type FindInput struct {
	Expression string
}

FindInput contains the input data require to Find.

See Also

Find

type FindOutput

type FindOutput struct {
	Meanings []Meaning
}

FindOutput contains the output payload from Find.

See Also

Find

func Find

func Find(input *FindInput) (*FindOutput, error)

Find try to find meanings for an expression on sinonimos.com.br.

type Meaning

type Meaning struct {
	Description string
	Synonyms    []string
	Examples    []string
}

Meaning contains information about an meaning.

See Also

Find

Directories

Path Synopsis
cmd

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL