Skip to content

Commit c7ddc9f

Browse files
update readme and workflows
1 parent 2fffabf commit c7ddc9f

File tree

3 files changed

+31
-11
lines changed

3 files changed

+31
-11
lines changed

.github/release-drafter.yml

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,18 +21,18 @@ categories:
2121
labels:
2222
- feature
2323
- enhancement
24-
- title: "🔧 Fixed"
24+
- title: "🔧 Issues Vanquished"
2525
labels:
2626
- fix
2727
- bugfix
28-
- title: "📖 Docs"
28+
- title: "📖 Knowledge Passed Down"
2929
labels:
3030
- documentation
31-
- title: "🧹 Tidying Up"
31+
- title: "🧹 Tidied Up"
3232
labels:
3333
- housekeeping
3434
- refactor
35-
- title: "🎙️ Testing testing testing"
35+
- title: "🎙️ Testing testing"
3636
labels:
3737
- test
3838

@@ -54,6 +54,15 @@ version-resolver:
5454
default: patch
5555

5656
template: |
57-
## In the Latest Episode of `AO3.js`...
57+
## In the Latest Episode of `@fujocoded/ao3.js`...
5858
5959
$CHANGES
60+
61+
### Upgrading to the latest version
62+
63+
You can install or upgrade to the latest version of `@fujocoded/ao3.js` by running
64+
the following command in your terminal:
65+
66+
```sh
67+
npm install @fujocoded/ao3.js@latest
68+
```

.github/workflows/npm-publish.yaml

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,5 +50,11 @@ jobs:
5050
5151
git add package.json package-lock.json
5252
53-
# The [skip ci] in the commit message prevents this commit from re-triggering workflows.
54-
git commit -m "${VERSION} has shipped ⛵🌟💖 [skip ci]"
53+
# Only commit if there are changes to commit so the action doesn't fail
54+
if ! git diff --staged --quiet; then
55+
# The [skip ci] in the commit message prevents this commit from re-triggering workflows.
56+
git commit -m "${VERSION} has shipped ⛵🌟💖 [skip ci]"
57+
git push
58+
else
59+
echo "No changes to commit."
60+
fi

README.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
![AO3.js logo](./logo-transparent-small.png)
66

7-
Scrapes data from [ao3.org](https://ao3.org). Now with Types™.
7+
Scrapes data from [ao3.org](https://ao3.org) and beyond. Now with Types™.
88

99
<!-- Add the <a> so IMGs will stay on the same line -->
1010
<a href="#">
@@ -18,14 +18,19 @@ Scrapes data from [ao3.org](https://ao3.org). Now with Types™.
1818
</a>
1919
<a href="https://fancoders.com/">
2020
<img src="https://img.shields.io/badge/fandom-coders-ff69b4" alt="Fandom Coders badge"/>
21+
</a>
22+
<a href="https://npmjs.com/package/@fujocoded/ao3.js">
23+
24+
![npm version](https://badge.fury.io/js/%40fujocoded%2Fao3.js.svg)
25+
2126
</a>
2227
</div>
2328

24-
## What it is
29+
## What is `@fujocoded/ao3.js`?
2530

26-
**AO3.js** is a Node.js (et al.) API for scraping AO3 (Archive of Our Own) data straight to your own JavaScript (or TypeScript) server. It provides an interface to retrieve information on AO3 tags, works, series, and more!
31+
**AO3.js is a Node.js library for fetching Archive of Our Own data** from your own JavaScript (or TypeScript!) server or command line tool. It provides an easy-to-use interface for retrieving information like tags, works, series, and more, from any AO3-compatible archive.
2732

28-
## What is capable of
33+
## What can `@fujocoded/ao3.js` do?
2934

3035
| Method | Description | Parameters | Return Type |
3136
| ----------------------------------------------------- | ------------------------------------------ | --------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ |

0 commit comments

Comments
 (0)