Skip to content

Commit 679c628

Browse files
authored
docs: update readme (#25)
1 parent c6ee57f commit 679c628

File tree

1 file changed

+24
-7
lines changed

1 file changed

+24
-7
lines changed

README.md

+24-7
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,27 @@
11
<h1 align="center">
22
<img style="margin: 50px 0px" width="400px" src="https://raw.githubusercontent.com/doc-han/xtensio/master/statics/xtensio.png" />
33
</h1>
4+
<p align="center">
5+
<b>Open-source javascript framework for browser extension development</b> <br />
6+
<b>No complex config • No experience with extensions required.</b> <br />
7+
</p>
8+
9+
<h4 align="center">
10+
<a href="https://github.com/doc-han/xtensio?tab=MIT-1-ov-file#readme">
11+
<img alt="GitHub License" src="https://img.shields.io/github/license/doc-han/xtensio?color=blue">
12+
</a>
13+
<a href="https://github.com/doc-han/xtensio">
14+
<img src="https://img.shields.io/badge/PR's-Welcome-brightgreen" alt="PRs welcome!" />
15+
</a>
16+
<a href="https://x.com/xtensiojs">
17+
<img src="https://img.shields.io/twitter/follow/xtensiojs?style=social"/>
18+
</a>
19+
20+
</h4>
21+
22+
check docs at [xtensio.io](https://xtensio.io/getting-started/)
23+
24+
### What is xtensio?
425

526
A javascript framework for building browser extensions. It takes away all the tedious configurations away from you and lowers the barrier to extension development.
627

@@ -127,26 +148,22 @@ Inside the background folder is an `index.ts` file which serves as your single e
127148

128149
> You can freely create other files in the background directory and use them or import them into the `index.ts` file.
129150
130-
131-
132-
### 🦋 Styles - Tailwind Css
151+
### 🦋 Styles - Tailwind Css
133152

134153
To include tailwind class utilities, you basically need to Opt in `[ select 'Y' ]` for Tailwind Css in the setup process
135-
We will do the all the heavy lifting. All you've to do is to `import tailwind.css` in any section being page,content, popup etc.
154+
We will do the all the heavy lifting. All you've to do is to `import tailwind.css` in any section being page,content, popup etc.
136155

137156
```js
138157
import { visitPage } from "xtensio";
139158
import "../tailwind.css"; //add this line
140159
...
141160
const buttonClickHandler = () => {
142-
visitPage("settings");
161+
visitPage("settings");
143162
}
144163

145164
return <button className={"px-10 py-1 bg-red-200 border ..."} onClick={buttonClickHandler}>Visit Settings Page</button>
146165
```
147166

148-
149-
150167
### 📜 Manifest.ts
151168

152169
This is the main file that handles most of the configurations related to a browser extension. It exports a JavaScript object as default which is used in generating the [manifest.json](https://developer.chrome.com/docs/extensions/mv3/manifest/) which is required when creating a browser extension.

0 commit comments

Comments
 (0)