Skip to content

Commit

Permalink
docs: Improve readme
Browse files Browse the repository at this point in the history
  • Loading branch information
fearandesire committed May 2, 2024
1 parent 63b920c commit 357f434
Showing 1 changed file with 8 additions and 6 deletions.
14 changes: 8 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

<div align="center">

[![License](https://img.shields.io/badge/license-MIT-blue.svg)](/LICENSE)
![NPM Downloads](https://img.shields.io/npm/d18m/resolve-team)
[![npm version](https://img.shields.io/npm/v/resolve-team.svg?style=flat)](https://www.npmjs.com/package/resolve-team)

</div>
Expand Down Expand Up @@ -31,24 +31,26 @@
## Features
- **Fuzzy Search**: Resolve sports teams via misspelled, partial, or full names using Fuse.js.
- **Team Details**: Get detailed information about the resolved team, including name, nicknames, abbreviations, and colors.
- **Type-Checked**: Ensures reliability and stability within your projects.
- **Customizable**: Offers options to customize the search sensitivity and limit searches to specific sports.

## Getting Started

### Installation
To integrate Resolve Team into your project, you can install it via npm:

_Via `npm`_
```bash
npm install resolve-team
```
_Via `yarn`_
```bash
yarn add resolve-team
```

## Usage
After installation, you can use the library to resolve sports team names by importing the `resolveTeam` function.

### API Reference

#### Parameters
### Parameters

The `resolveTeam` function accepts the following parameters:

Expand All @@ -74,7 +76,7 @@ Basic usage and examples of the `resolveTeam` function:
```js
import { resolveTeam } from 'resolve-team';

// Basic name resolution
// Standard usage, will resolve the team name directly.
const nbaTeam = resolveTeam(`Bos`); // 'Boston Celtics'

// Fuzzy search example
Expand Down

0 comments on commit 357f434

Please sign in to comment.