From 4db21a01f74f8ee7d7496cde48207f6773ccf917 Mon Sep 17 00:00:00 2001 From: Alexander Sullivan Date: Sun, 25 Aug 2024 17:34:40 -0400 Subject: [PATCH] Update version to v3 --- CHANGELOG.md | 26 +++++++++++++++++++++++++- SECURITY.MD | 2 +- package-lock.json | 4 ++-- package.json | 2 +- 4 files changed, 29 insertions(+), 5 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index bf61808..b450857 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -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 diff --git a/SECURITY.MD b/SECURITY.MD index 7c0fa9b..0c99b78 100644 --- a/SECURITY.MD +++ b/SECURITY.MD @@ -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). diff --git a/package-lock.json b/package-lock.json index 31719eb..9c102b3 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "publication-figure-retriever", - "version": "2.1.1", + "version": "3.0.0", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "publication-figure-retriever", - "version": "2.1.1", + "version": "3.0.0", "license": "GNU General Public License v2.0", "dependencies": { "axios": "^1.7.5", diff --git a/package.json b/package.json index a0c0977..a13a4dd 100644 --- a/package.json +++ b/package.json @@ -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": {