Skip to content

Commit

Permalink
Adds readme
Browse files Browse the repository at this point in the history
  • Loading branch information
scandar committed Jun 22, 2024
1 parent 1b48e2a commit 5761a60
Showing 1 changed file with 42 additions and 0 deletions.
42 changes: 42 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# mal-cli - A CLI for MyAnimeList

mal-cli is a CLI for MyAnimeList, written in GO. It allows you to search for anime and manga, view details about them, add them to your list, and edit your list.

## Installation

```bash
go get github.com/scandar/mal-cli
```

## Usage

```bash
mal-cli [command]
```

## Authentication

Before using the tool you need to authenticate with MyAnimeList. You can do this by running the following command:

```bash
mal-cli auth
```

## Commands

```bash
anime-details Get anime details
anime-list Authenticated user's anime list
auth Authenticate with MyAnimeList
completion Generate the autocompletion script for the specified shell
delete-anime Delete an entry from the user's anime list
delete-manga Delete an entry from the user's manga list
find-anime Search for anime by name
find-manga Search for manga by name
help Help about any command
manga-details Get manga details
manga-list Authenticated user's manga list
me Get authenticated user info
update-anime Update an entry in the user's anime list
update-manga Update an entry in the user's manga list
```

0 comments on commit 5761a60

Please sign in to comment.