Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jcbrand committed Jul 31, 2023
1 parent 514da9d commit 21e8e98
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,12 @@ which is very similar to the original Backbone `View` but which is also a web
component that gets instantiated automatically as soon as its rendered in the
DOM.

## Installation

```
npm install @converse/skeletor
```

## Why bother?

The goal of this fork is to allow the Converse team to gradually update the [Converse](https://conversejs.org)
Expand All @@ -35,7 +41,6 @@ We can cheat a little by letting the existing Views also be web components
(more accurately, "custom elements"), this allows us to declaratively render the
UI, while we're progressively getting rid of the views.

![](https://raw.githubusercontent.com/conversejs/skeletor/master/images/skeletor2.jpg)

## Sekeletor adds the following changes to Backbone

Expand Down Expand Up @@ -70,7 +75,6 @@ UI, while we're progressively getting rid of the views.
4. Use `includes` instead of `contains`
5. The `partition` and `invokeMap` methods have been removed.

![](https://raw.githubusercontent.com/conversejs/skeletor/master/images/skeletor3.jpg)
### ElementView example

The ElementView looks very similar to a normal Backbone View.
Expand Down Expand Up @@ -123,3 +127,5 @@ the browser, your ElementView will automatically be instantiated and
<my-custom-button></my-custom-button>
</div>
```

![](https://raw.githubusercontent.com/conversejs/skeletor/master/images/skeletor2.jpg)

0 comments on commit 21e8e98

Please sign in to comment.