You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Uses old $HOME/.mal data dir when available but automatically switches
to $XDG_CACHE_HOME/mal whenever possible. Updates readme to reflect
these changes
Copy file name to clipboardExpand all lines: README.md
+29-29Lines changed: 29 additions & 29 deletions
Original file line number
Diff line number
Diff line change
@@ -15,16 +15,16 @@ In order to have `mal copy` command working, you need to have either `xsel` or `
15
15
16
16
## Quick start
17
17
18
-
If you have a working Go environment, you can download the app via `go get -u github.com/aqatl/mal`.
18
+
If you have a working Go environment, you can download the app via `go get -u github.com/aqatl/mal`.
19
19
Otherwise, download binaries from the [release](https://github.com/aQaTL/MAL/releases) page.
20
20
21
-
Remember that everything is stored in `$HOME/.mal` or `%userprofile%\.mal` (Windows).
21
+
Remember that everything is stored in `$XDG_CACHE_HOME/mal` or `%LocalAppData%\mal` (Windows).
22
22
23
23
### AniList mode
24
24
25
-
AniList mode is used by default. All you need to do to configure the app is to simply execute the program.
26
-
It'll open AniList login page in your browser. Log in and authorize the app. And that's it - mal will cache
27
-
the received token on your disk and use it to authenticate your requests.
25
+
AniList mode is used by default. All you need to do to configure the app is to simply execute the program.
26
+
It'll open AniList login page in your browser. Log in and authorize the app. And that's it - mal will cache
27
+
the received token on your disk and use it to authenticate your requests.
28
28
29
29
Run mal with `-r` flag to refresh cached lists.
30
30
@@ -34,14 +34,14 @@ Run mal with `-r` flag to refresh cached lists.
34
34
35
35
To switch between AniList and MyAnimeList mode use the `s` command (e.g. `mal s`).
36
36
37
-
First, you need to give the app your credentials - username and password. To do that, execute
38
-
`mal --prompt-credentials --verify --save-password`. If everything went good, you should see
37
+
First, you need to give the app your credentials - username and password. To do that, execute
38
+
`mal --prompt-credentials --verify --save-password`. If everything went good, you should see
39
39
a list of 10 entries.
40
40
41
41
### Default behavior
42
42
43
-
The base command for everything is `mal`, which by default displays 10 last updated entries
44
-
from your MAL. You can change the displayed list through some flags:
43
+
The base command for everything is `mal`, which by default displays 10 last updated entries
44
+
from your MAL. You can change the displayed list through some flags:
45
45
46
46
```
47
47
--max value visible entries threshold (default: 0)
@@ -53,7 +53,7 @@ from your MAL. You can change the displayed list through some flags:
53
53
54
54
It's also good to run the app with `-r` (or `--refresh`) to update the cached list. Mind that there is not refresh interval so you have to refresh manually.
55
55
56
-
List of all commands and possible flags is available via `mal --help`.
56
+
List of all commands and possible flags is available via `mal --help`.
57
57
58
58
### Commands
59
59
@@ -66,14 +66,14 @@ Commands listed in `help` are divides into categories:
66
66
***Action** command performs action that uses the entry data like printing it to the console
67
67
***Config** command manipulates on the app configuration file (look at `mal cfg --help` for details)
68
68
69
-
You can always see the details of the specific command via `help` like this:
69
+
You can always see the details of the specific command via `help` like this:
70
70
`mal <command> --help`
71
71
72
72
#### Select entry to work with
73
73
74
-
Commands that use entry data need to know which entry you want to use. And there's a thing
75
-
called "selected entry". To select an entry, use the `mal sel` command. And here's a usage
76
-
of that command (` mal sel --help`):
74
+
Commands that use entry data need to know which entry you want to use. And there's a thing
75
+
called "selected entry". To select an entry, use the `mal sel` command. And here's a usage
76
+
of that command (` mal sel --help`):
77
77
78
78
```
79
79
NAME:
@@ -91,7 +91,7 @@ If `sel` is given no arguments, it will open a fuzzy search cui (console gui).
91
91
92
92
#### Update entry
93
93
94
-
For now, you can update your entry with the following commands:
94
+
For now, you can update your entry with the following commands:
95
95
96
96
```
97
97
eps, episodes Set the watched episodes value. If n not specified, the number will be increased by one
@@ -114,8 +114,8 @@ CATEGORY:
114
114
Update
115
115
```
116
116
117
-
There's an option to have mal automatically turn the entry status to completed after updating
118
-
the watched episodes value. To do that, use the `status-auto-update` config command.
117
+
There's an option to have mal automatically turn the entry status to completed after updating
118
+
the watched episodes value. To do that, use the `status-auto-update` config command.
119
119
120
120
```
121
121
NAME:
@@ -127,11 +127,11 @@ USAGE:
127
127
128
128
As you can see, there are 2 modes of auto-update: normal and after-threshold.
129
129
130
-
The first behaves as you would expect -> the status is changes when entry has 12 episodes
130
+
The first behaves as you would expect -> the status is changes when entry has 12 episodes
131
131
and you hit the 12 watched episodes.
132
132
133
-
As for the `after-threshold`, the status will change after you exceed the number of
134
-
episodes. For example: when entry has 12 episodes and you hit 13 -> status is changed to
133
+
As for the `after-threshold`, the status will change after you exceed the number of
134
+
episodes. For example: when entry has 12 episodes and you hit 13 -> status is changed to
135
135
completed and your watched entries value is changed back to 12.
136
136
137
137
##### `mal score` command
@@ -173,16 +173,16 @@ Remember that everything is in `--help` :)
173
173
174
174
### Everyday usage
175
175
176
-
Okay, so when I add a new anime to my list, I run `mal -r` to update the cache. Then, if I
177
-
want to watch it, I select it with `mal sel [name]`. Then I go to the web browser to find a
178
-
website where I can watch it. If the name is long, I copy the title with `mal copy title`.
179
-
To not forget the website and make it a little bit more convenient for me in the future, I
180
-
copy the website's link and bind it to the selected anime with `mal web [website url]`.
176
+
Okay, so when I add a new anime to my list, I run `mal -r` to update the cache. Then, if I
177
+
want to watch it, I select it with `mal sel [name]`. Then I go to the web browser to find a
178
+
website where I can watch it. If the name is long, I copy the title with `mal copy title`.
179
+
To not forget the website and make it a little bit more convenient for me in the future, I
180
+
copy the website's link and bind it to the selected anime with `mal web [website url]`.
181
181
182
-
Now, when I want to watch it, I can just type `mal web` and it will open saved url in the
183
-
web browser (you can configure which browser to use). When I finish an episode I type
184
-
`mal eps` to update watched episodes and that's it. There's an option to automatically set
185
-
the status to "completed", so I don't have to do anything more.
182
+
Now, when I want to watch it, I can just type `mal web` and it will open saved url in the
183
+
web browser (you can configure which browser to use). When I finish an episode I type
184
+
`mal eps` to update watched episodes and that's it. There's an option to automatically set
185
+
the status to "completed", so I don't have to do anything more.
186
186
187
187
Oh, and usually I also rate the show by `mal score [number from 0 to 10]`.
0 commit comments