Skip to content

Commit

Permalink
feat: slight README.md change
Browse files Browse the repository at this point in the history
  • Loading branch information
quentinderoubaix committed Feb 1, 2024
1 parent 19b0440 commit 8021ed8
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 3 deletions.
19 changes: 18 additions & 1 deletion INSTALLATION.md
Original file line number Diff line number Diff line change
@@ -1 +1,18 @@
To be done...
## Installation

AgnosUI delivers the following npm packages:

- [@agnos-ui/core](https://www.npmjs.com/package/@agnos-ui/core)
- [@agnos-ui/angular-headless](https://www.npmjs.com/package/@agnos-ui/angular-headless)
- [@agnos-ui/angular](https://www.npmjs.com/package/@agnos-ui/angular)
- [@agnos-ui/react-headless](https://www.npmjs.com/package/@agnos-ui/react-headless)
- [@agnos-ui/react](https://www.npmjs.com/package/@agnos-ui/react)
- [@agnos-ui/svelte-headless](https://www.npmjs.com/package/@agnos-ui/svelte-headless)
- [@agnos-ui/svelte](https://www.npmjs.com/package/@agnos-ui/svelte)
- [@agnos-ui/page-objects](https://www.npmjs.com/package/@agnos-ui/page-objects)

You may install the package(s) you require with a sample

```bash
npm install @agnos-ui/{package}
```
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,15 @@
# AgnosUI: A Versatile Frontend Widget Library for CSS Bootstrap Design
<h1 align="center">AgnosUI - Where web widgets shine</h1>

<p align="center">
<img src="demo/static/agnosui-logo.svg" alt="angular-logo" width="120px" height="120px"/>
</p>

[![Build Status](https://github.com/AmadeusITGroup/AgnosUI/workflows/ci/badge.svg?branch=main)](https://github.com/AmadeusITGroup/AgnosUI/actions)
[![codecov](https://codecov.io/gh/AmadeusITGroup/AgnosUI/branch/main/graph/badge.svg)](https://codecov.io/gh/AmadeusITGroup/AgnosUI)

## Introduction

AgnosUI is a powerful library of widgets designed specifically for the [CSS Bootstrap design](https://getbootstrap.com/). Inspired by the success of [ng-bootstrap](https://ng-bootstrap.github.io/), AgnosUI takes the concept a step further by offering widgets that can seamlessly integrate with any front-end framework of your choice. With support for popular frameworks like [Angular](https://angular.io/), [React](https://react.dev/), and [Svelte](https://svelte.dev/), AgnosUI allows you to effortlessly create consistent and visually appealing UI components across your projects.
AgnosUI is a powerful library that provides configurable Typescript widget factories, headless wrappers and ready-to-use widgets compliant to the [CSS Bootstrap design](https://getbootstrap.com/). Inspired by the success of [ng-bootstrap](https://ng-bootstrap.github.io/), AgnosUI takes the concept a step further by offering widgets that can seamlessly integrate with any front-end framework of your choice. With support for popular frameworks like [Angular](https://angular.io/), [React](https://react.dev/), and [Svelte](https://svelte.dev/), AgnosUI allows you to effortlessly create consistent and visually appealing UI components across your projects.

Feel free to explore the [demo site](https://amadeusitgroup.github.io/AgnosUI/latest/) to see AgnosUI's capabilities.

Expand Down
1 change: 1 addition & 0 deletions demo/vite.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,7 @@ export default defineConfig({
'svelte-markdown',
'marked',
'mermaid',
'@stackblitz/sdk',
],
},
});

0 comments on commit 8021ed8

Please sign in to comment.