Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
izo0x90 authored Nov 14, 2024
1 parent b2c6291 commit c3a980e
Showing 1 changed file with 18 additions and 1 deletion.
19 changes: 18 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,19 @@
# kiss-components.js
# :kiss: kiss-components.js
Ultra minimalistic UI/Web components and Chrome extension Javascript framework. (OMG not another one!)

There are two parts to this "framework" that are related but can be used independantly from eachother:
- KISS-WebUI, This is a minimal WebComponent framework that provides just enough scaffold to define a UI App and Components
- KISS-Chrome-extension, This is a minimal library (yes, this one is just a library) to help with writing Chrome extensions

And I suppose there is third part to all of this:
- Set of boilerplate templates that go along with the peices mentioned above, as a way to setup projects quickly and define the intended approach

## WebUI Overview
- A simplified way to define WebComponents
...
...
...

## Chrome-extension Overview
- A message dispatching and command registration system to allow interactions between the extension and the content sctipts (where the actual website code/ data reside)
- A way to easily inject content scripts in the site and use code sparated in ECMA modules

0 comments on commit c3a980e

Please sign in to comment.