Skip to content

Commit

Permalink
Updated GitHub readme to reference NPM readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
alancleary committed Aug 3, 2023
1 parent 69d708d commit c5a1ce1
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion .github/README.md
Original file line number Diff line number Diff line change
@@ -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:
Expand Down

0 comments on commit c5a1ce1

Please sign in to comment.