Skip to content

Commit

Permalink
Update version to v3
Browse files Browse the repository at this point in the history
  • Loading branch information
AlexJSully committed Aug 25, 2024
1 parent 83af475 commit 4db21a0
Show file tree
Hide file tree
Showing 4 changed files with 29 additions and 5 deletions.
26 changes: 25 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,31 @@ All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](http://keepachangelog.com/) and this project adheres to [Semantic Versioning](http://semver.org/).

To see tags and releases, please go to [Tags](https://github.com/AlexJSully/Publication-Figures-Web-Scraping/tags) on [GitHub](https://github.com/AlexJSully/Publication-Figures-Web-Scraping).
To see tags and releases, please go to [Tags](https://github.com/AlexJSully/Publication-Figure-Retrieval/tags) on [GitHub](https://github.com/AlexJSully/Publication-Figure-Retrieval).

## [3.0.0] - 2024-08-25

The `Publication Figures Web Scraper` has been renamed to `Publication Figure Retrieval` as it no longer scrapes data from the web. Instead, it retrieves data from the NCBI API. This major change was done to comply with the NCBI's terms of service and policies.

Feature:

- No longer scrapes data from the web, instead retrieves data from the NCBI API

Optimization:

- Added TypeScript support and reorganized the codebase

Security:

- Update Axios package to fix security vulnerabilities

Documentation:

- Rewrote README.md to reflect the changes

Update:

- Updated packages, including Axios & ESLint (removed Sentry)

## [2.1.1] - 2024-08-08

Expand Down
2 changes: 1 addition & 1 deletion SECURITY.MD
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ We are actively maintaining and developing on the latest build on the master bra

## Reporting a Vulnerability

If you want to report a security vulnerability, you can do so [on the GitHub issues page](https://github.com/AlexJSully/Publication-Figures-Web-Scraping/issues/new/choose).
If you want to report a security vulnerability, you can do so [on the GitHub issues page](https://github.com/AlexJSully/Publication-Figure-Retrieval/issues/new/choose).
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "publication-figure-retriever",
"version": "2.1.1",
"version": "3.0.0",
"description": "This tool provides a method for retrieving figures from NCBI's PubMed publications using NIH APIs for open access and publicly available publications.",
"main": "index.ts",
"scripts": {
Expand Down

0 comments on commit 4db21a0

Please sign in to comment.