Skip to content

Commit

Permalink
docs: updated content of readme
Browse files Browse the repository at this point in the history
removed notice and updated roadmap
  • Loading branch information
torbrenner committed Sep 5, 2024
1 parent 8318f66 commit 9b107a8
Showing 1 changed file with 4 additions and 11 deletions.
15 changes: 4 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,6 @@

samply.lens is a front-end library, that provides common functionalities necessary for building search-, exploration and visualization applications. The primary target of this library is to deliver a good amount of building blocks, while also being open to user specific extensions.

## Important Notice
The library is currently undergoing a change in the technological stack. Because of this, the current api is not completly finalized and is subject to changes in the next months.

Our main reasons for doing a complete rewrite of the samply.lens are that we wanted to make the provided components more adjustable for users and allow an framework independent usage. Because of this, we switched from writting a [PrimeNG](https://www.primefaces.org/primeng) based [Angular](https://angular.io/) component library, to writting a web components library based on [Svelte](https://svelte.dev/) and plain CSS.

The old version of the library, will be no longer maintained. If you want to take a look at the source code, you can still find it [here](https://github.com/samply/lens-angular).

## Development Setup
If you want to setup a development environment for the samply.lens library, you will need a recent version of [Node.js and npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) installed on your system.

Expand Down Expand Up @@ -59,16 +52,16 @@ lens-info-button::part(info-button-icon) {
```

## Roadmap
- On a short term, we plan on publishing the library on [npmjs](https://www.npmjs.com/). We plan to make it available as [@samply/lens](https://www.npmjs.com/package/@samply/lens)
- After making the library available on npm, we will move the `AppCCP.svelte`, `AppBBMRI.svelte` and `AppGBA.svelte` to their separate repositories that are just using this library.
- On the long term, we plan to stabilize the api and configuration options the library offers and will document them here.
- [x] On a short term, we plan on publishing the library on [npmjs](https://www.npmjs.com/). We plan to make it available as [@samply/lens](https://www.npmjs.com/package/@samply/lens)
- [ ] After making the library available on npm, we will move the `AppCCP.svelte`, `AppBBMRI.svelte` and `AppGBA.svelte` to their separate repositories that are just using this library.
- [ ] On the long term, we plan to stabilize the api and configuration options the library offers and will document them here.

## Build With
- [Svelte](https://svelte.dev/)

## License

Copyright 2019 - 2023 The Samply Community
Copyright 2019 - 2024 The Samply Community

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

Expand Down

0 comments on commit 9b107a8

Please sign in to comment.