From edb0074cb9e9ced0f91638afc5f95539dbd1de70 Mon Sep 17 00:00:00 2001 From: Alan Cleary Date: Thu, 3 Aug 2023 09:14:55 -0600 Subject: [PATCH 1/8] Moved GitHub readme into .github/ directory. --- README.md => .github/README.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename README.md => .github/README.md (100%) diff --git a/README.md b/.github/README.md similarity index 100% rename from README.md rename to .github/README.md From cf6b197a3873d464e5bda592065042e11a1b1aee Mon Sep 17 00:00:00 2001 From: Alan Cleary Date: Thu, 3 Aug 2023 10:37:50 -0600 Subject: [PATCH 2/8] Added NPM readme. --- README.md | 46 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 46 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..12fac07 --- /dev/null +++ b/README.md @@ -0,0 +1,46 @@ +# `@legumeinfo/web-components` + +## A Web Component library + +**`@legumeinfo/web-components` is an [open-source](https://github.com/legumeinfo/web-components) Web Component library** for interacting with and visualizing biological data. +The Web Components can be used as is in your HTML or extended in your own JavaScript/TypeScript library. + +## Documentation + +Full user documentation for `@legumeinfo/web-components` is available on [our documentation site](https://legumeinfo.github.io/web-components/). +Technical documentation for developers is available on [GitHub](https://github.com/legumeinfo/web-components). +This README shows the basics of installing the library and using Web Components, but most features are only documented on our docs site. + +## Getting started + +`@legumeinfo/web-components` does not use the [Shadow DOM](https://developer.mozilla.org/en-US/docs/Web/API/Web_Components/Using_shadow_DOM) in preference for inheriting global styles. +Specifically, `@legumeinfo/web-components` assumes [UIkit](https://getuikit.com/) has been loaded in the document, so be sure to install this before using the library. + +Install library as follows: + +``` +npm install @legumeinfo/web-components +``` + +The library can then be used in your HTML as follows: + +```html + + + + + + + + + + +``` + +The library can be used in your JavaScript/TypeScriplibrary as follows: + +```typescript +import { LisGeneSearchElement } from '@legumeinfo/web-components'; + +class MySearchElement extends LisGeneSearchElement { } +``` From 16424e8bfb42da164132fae0b5320d65ba8a6fd4 Mon Sep 17 00:00:00 2001 From: Alan Cleary Date: Thu, 3 Aug 2023 10:42:12 -0600 Subject: [PATCH 3/8] Fixed typos in the NPM readme. --- README.md | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 12fac07..b9ba783 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,5 @@ # `@legumeinfo/web-components` -## A Web Component library - **`@legumeinfo/web-components` is an [open-source](https://github.com/legumeinfo/web-components) Web Component library** for interacting with and visualizing biological data. The Web Components can be used as is in your HTML or extended in your own JavaScript/TypeScript library. @@ -16,7 +14,7 @@ This README shows the basics of installing the library and using Web Components, `@legumeinfo/web-components` does not use the [Shadow DOM](https://developer.mozilla.org/en-US/docs/Web/API/Web_Components/Using_shadow_DOM) in preference for inheriting global styles. Specifically, `@legumeinfo/web-components` assumes [UIkit](https://getuikit.com/) has been loaded in the document, so be sure to install this before using the library. -Install library as follows: +Install the library as follows: ``` npm install @legumeinfo/web-components @@ -25,8 +23,8 @@ npm install @legumeinfo/web-components The library can then be used in your HTML as follows: ```html - + @@ -37,7 +35,7 @@ The library can then be used in your HTML as follows: ``` -The library can be used in your JavaScript/TypeScriplibrary as follows: +The library can be used in your JavaScript/TypeScrip library as follows: ```typescript import { LisGeneSearchElement } from '@legumeinfo/web-components'; From a08ca9046b2cd3dac77823b7bfb3bfd6e305f069 Mon Sep 17 00:00:00 2001 From: Alan Cleary Date: Thu, 3 Aug 2023 10:45:19 -0600 Subject: [PATCH 4/8] Updated GitHub readme to reference NPM readme. --- .github/README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/.github/README.md b/.github/README.md index 375bf57..474c585 100644 --- a/.github/README.md +++ b/.github/README.md @@ -1,9 +1,12 @@ -# LIS Web Components +# `@legumeinfo/web-components` This repository contains a Web Component library developed for the Legume Information System and other AgBio databases. The Web Components are built using [Lit](https://lit.dev/) and the [UIkit](https://getuikit.com/) CSS framework. UIkit, however, is only listed as a development dependency and must be installed independently when using this library. +This readme is intended for developers. +For user documentation, see the [NPM readme](https://github.com/legumeinfo/web-components/blob/main/README.md) and [our documentation site](https://legumeinfo.github.io/web-components/). + ## Setup Install dependencies: From 8338e7d3aaf4a1760ef87ae9e50720499844c265 Mon Sep 17 00:00:00 2001 From: Alan Cleary Date: Thu, 3 Aug 2023 10:52:34 -0600 Subject: [PATCH 5/8] Added fields to package.json for publishing to NPM registry. --- package.json | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index f4529e6..717a95a 100644 --- a/package.json +++ b/package.json @@ -2,6 +2,14 @@ "name": "@legumeinfo/web-components", "version": "0.0.1", "description": "Web Components for the Legume Information System and other AgBio databases", + "repository": { + "type": "git", + "url": "https://github.com/apollographql/web-components" + }, + "bugs": { + "url": "https://github.com/legumeinfo/web-components/issues" + }, + "homepage": "https://github.com/legumeinfo/web-components#readme", "main": "lib/index.js", "module": "lib/index.js", "types": "lib/index.d.ts", @@ -37,10 +45,13 @@ "bundle:watch": "rollup -c -w" }, "keywords": [ + "typescript", "lit", "web-components", - "typescript", - "legumes" + "uikit", + "legumes", + "agbio", + "biology" ], "author": "Legume Information System", "license": "Apache-2.0", From 877dffc74b091a9cb7758f41a19a36fbb98721bf Mon Sep 17 00:00:00 2001 From: Alan Cleary Date: Thu, 3 Aug 2023 10:54:00 -0600 Subject: [PATCH 6/8] Bumped version to 1.0.0 --- package-lock.json | 4 ++-- package.json | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/package-lock.json b/package-lock.json index 9280876..2e2f6a0 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@legumeinfo/web-components", - "version": "0.0.1", + "version": "1.0.0", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "@legumeinfo/web-components", - "version": "0.0.1", + "version": "1.0.0", "license": "Apache-2.0", "dependencies": { "lit": "^2.7.6" diff --git a/package.json b/package.json index 717a95a..fe669c7 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@legumeinfo/web-components", - "version": "0.0.1", + "version": "1.0.0", "description": "Web Components for the Legume Information System and other AgBio databases", "repository": { "type": "git", From 2c8a5db7cf1586299e508d6d37fdabcf3310bb54 Mon Sep 17 00:00:00 2001 From: Alan Cleary Date: Thu, 3 Aug 2023 13:51:37 -0600 Subject: [PATCH 7/8] Fixed typo in readme. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index b9ba783..33e526c 100644 --- a/README.md +++ b/README.md @@ -31,7 +31,7 @@ The library can then be used in your HTML as follows: - + ``` From c3eaeb5a0999419183d6d53112ce34c5c41b6da0 Mon Sep 17 00:00:00 2001 From: Alan Cleary Date: Thu, 3 Aug 2023 22:15:16 -0600 Subject: [PATCH 8/8] Fixed broken script links in linkout examples. --- dev/examples/lis-gene-search-with-linkouts.html | 2 +- dev/lis-linkout-element.html | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/dev/examples/lis-gene-search-with-linkouts.html b/dev/examples/lis-gene-search-with-linkouts.html index 64e1206..51a5ad0 100644 --- a/dev/examples/lis-gene-search-with-linkouts.html +++ b/dev/examples/lis-gene-search-with-linkouts.html @@ -14,7 +14,7 @@ - + diff --git a/dev/lis-linkout-element.html b/dev/lis-linkout-element.html index 6e1c720..f2357f5 100644 --- a/dev/lis-linkout-element.html +++ b/dev/lis-linkout-element.html @@ -14,7 +14,7 @@ - +