Merge pull request #63 from brittni-and-the-polar-bear/development-main

Development main
brittni-and-the-polar-bear · Jul 29, 2024 · 3eb81b2 · 3eb81b2
2 parents 99c4b7f + bd35c31
commit 3eb81b2
Show file tree

Hide file tree

Showing 7 changed files with 305 additions and 165 deletions.
diff --git a/.github/workflows/node.js.yml b/.github/workflows/node.js.yml
@@ -31,5 +31,5 @@ jobs:
           node-version: ${{ matrix.node-version }}
           cache: 'npm'
       - run: npm ci
-      - run: npm run build:source --if-present
+      - run: npm run build:source
       - run: npm test
diff --git a/.github/workflows/npm-publish-github.yml b/.github/workflows/npm-publish-github.yml
@@ -16,7 +16,7 @@ jobs:
         with:
           node-version: '20.x'
       - run: npm ci
-      - run: npm run build:source --if-present
+      - run: npm run build:source
       - run: npm test
 
   publish-npm:

diff --git a/.github/workflows/npm-publish.yml b/.github/workflows/npm-publish.yml
@@ -16,7 +16,7 @@ jobs:
         with:
           node-version: '20.x'
       - run: npm ci
-      - run: npm run build:source --if-present
+      - run: npm run build:source
       - run: npm test
 
   publish-npm:

diff --git a/README.md b/README.md
@@ -1,29 +1,50 @@
-# Generative Art Library: Color Palettes
+# WARNING: This package is DEPRECATED and the repository has been ARCHIVED.
+
+## The funcionality of this package has been moved to [@batpb/genart](https://www.npmjs.com/package/@batpb/genart) and the [generative-art-library repository](https://github.com/brittni-and-the-polar-bear/generative-art-library).
+
+# [@batpb/genart-palettes](https://www.npmjs.com/package/@batpb/genart-palettes) - generative art library color palettes package
 
 Copyright (C) 2023-2024 brittni and the polar bear LLC.
 
-Color palette classes and methods for the brittni and the polar bear [generative art library](https://github.com/brittni-and-the-polar-bear/generative-art-library).
+Color palette classes and methods for the brittni and the polar bear 
+[generative art library](https://brittni-and-the-polar-bear.github.io/generative-art-library/).
 
 ## Summary
 
-[![CodeQL](https://github.com/brittni-and-the-polar-bear/generative-art-library_color-palettes/actions/workflows/codeql.yml/badge.svg)](https://github.com/brittni-and-the-polar-bear/generative-art-library_color-palettes/actions/workflows/codeql.yml)
-[![Node.js Build and Test](https://github.com/brittni-and-the-polar-bear/generative-art-library_color-palettes/actions/workflows/node.js.yml/badge.svg)](https://github.com/brittni-and-the-polar-bear/generative-art-library_color-palettes/actions/workflows/node.js.yml)
+[![CodeQL](https://github.com/brittni-and-the-polar-bear/generative-art-library_color_palettes/actions/workflows/codeql.yml/badge.svg)](https://github.com/brittni-and-the-polar-bear/generative-art-library_color_palettes/actions/workflows/codeql.yml)
+[![Node.js Build and Test](https://github.com/brittni-and-the-polar-bear/generative-art-library_color_palettes/actions/workflows/node.js.yml/badge.svg)](https://github.com/brittni-and-the-polar-bear/generative-art-library_color_palettes/actions/workflows/node.js.yml)
 
-![NPM Version](https://img.shields.io/npm/v/%40batpb%2Fgenart-palettes)
-![GitHub Release Date - Published_At](https://img.shields.io/github/release-date/brittni-and-the-polar-bear/generative-art-library_color-palettes)
-![GitHub License](https://img.shields.io/github/license/brittni-and-the-polar-bear/generative-art-library_color-palettes)
+[![NPM Version](https://img.shields.io/npm/v/%40batpb%2Fgenart-palettes)
+![GitHub Release Date - Published_At](https://img.shields.io/github/release-date/brittni-and-the-polar-bear/generative-art-library_color_palettes)
+![GitHub License](https://img.shields.io/github/license/brittni-and-the-polar-bear/generative-art-library_color_palettes)](https://www.npmjs.com/package/@batpb/genart-palettes)
 
 [![Socket Badge](https://socket.dev/api/badge/npm/package/@batpb/genart-palettes)](https://socket.dev/npm/package/@batpb/genart-palettes)
 
 ![NPM Downloads](https://img.shields.io/npm/dw/%40batpb%2Fgenart-palettes)
 
-![GitHub issues by-label (bug)](https://img.shields.io/github/issues/brittni-and-the-polar-bear/generative-art-library_color-palettes/bug?color=red)
-![GitHub issues by-label (security)](https://img.shields.io/github/issues/brittni-and-the-polar-bear/generative-art-library_color-palettes/security?color=red)
+![GitHub issues by-label (bug)](https://img.shields.io/github/issues/brittni-and-the-polar-bear/generative-art-library_color_palettes/bug?color=red)
+![GitHub issues by-label (security)](https://img.shields.io/github/issues/brittni-and-the-polar-bear/generative-art-library_color_palettes/security?color=red)
 
-![GitHub commits since latest release](https://img.shields.io/github/commits-since/brittni-and-the-polar-bear/generative-art-library_color-palettes/latest)
+![GitHub commits since latest release](https://img.shields.io/github/commits-since/brittni-and-the-polar-bear/generative-art-library_color_palettes/latest)
 
-![GitHub contributors](https://img.shields.io/github/contributors-anon/brittni-and-the-polar-bear/generative-art-library_color-palettes)
+![GitHub contributors](https://img.shields.io/github/contributors-anon/brittni-and-the-polar-bear/generative-art-library_color_palettes)
 
 ## LICENSE Information
 
-The source code of this project is licensed under the [GNU Affero General Public Version 3.0 License](https://www.gnu.org/licenses/agpl-3.0.en.html). The full text of the license can be found in the LICENSE file of the root directory.
+The source code of this project is licensed under the 
+[GNU Affero General Public Version 3.0 License](https://www.gnu.org/licenses/agpl-3.0.en.html). 
+The full text of the license can be found in the 
+[LICENSE file](https://github.com/brittni-and-the-polar-bear/generative-art-library_color_palettes/blob/main/LICENSE) 
+of the root directory.
+
+----
+
+# Getting Started
+
+## Install with [npm](https://www.npmjs.com/)
+
+```
+npm install @batpb/genart-palettes
+```
+
+----