Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: use correct readme, bump version back to 13 #20

Merged
merged 1 commit into from
Oct 15, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 43 additions & 2 deletions .github/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,44 @@
# library-template
# scraper

Template for creating new libraries.
A set of utilities focused on scraping the [VEX Robotics Q&A](https://www.robotevents.com/V5RC/2024-2025/QA/).

## Usage

### Retreiving All Questions

```ts
import { getAllQuestions } from "@qnaplus/scraper";

(async () => {
const questions = await getAllQuestions();
})();
```

### Retreiving and Filtering Questions

```ts
import { getQuestions } from "@qnaplus/scraper";

(async () => {
// gets all questions from the current season
const currentSeasonQuestions = await getQuestions();

// get all questions from a particular season
const specificSeasonQuestions = await getQuestions(["2020-2021"]);

// get all VURC questions from the 2020-2021 season
const filteredQuestions = await getQuestions({
VURC: ["2020-2021"]
});
})();
```

### Retrieving Unanswered Questions

```ts
import { getUnansweredQuestions } from "@qnaplus/scraper";

(async () => {
const questions = await getUnansweredQuestions();
})();
```
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@qnaplus/scraper",
"version": "1.0.0",
"version": "13.0.0",
"description": "Utility package to scrape questions from the VEX Robotics Q&A.",
"main": "dist/index.js",
"repository": {
Expand Down
Loading