From c5a1ce14d31dc259dbc612d3ac76257f7aed3924 Mon Sep 17 00:00:00 2001 From: Alan Cleary Date: Thu, 3 Aug 2023 10:45:19 -0600 Subject: [PATCH] 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: