Skip to content

Commit 69461e6

Browse files
docs update
1 parent e2173c6 commit 69461e6

File tree

2 files changed

+13
-2
lines changed

2 files changed

+13
-2
lines changed

README.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,22 @@
11
# Tiny Browser Framework
22

3+
[![npm](https://img.shields.io/npm/v/tiny-browser-framework.svg)]()
34
[![Build Status](https://travis-ci.org/thedumbterminal/TinyBrowserFramework.svg?branch=master)](https://travis-ci.org/thedumbterminal/TinyBrowserFramework)
45

56
Tiny browser web framework, which communicates to the server via a websocket. All DOM changes are performed using HTML provided by the server.
67

78
Minified size is 2.25 Kb which when transmitted compressed is 858 Bytes!
89

10+
## Usage
11+
12+
Install the package:
13+
14+
npm install tiny-browser-framework
15+
16+
Then create a script tag in your HTML to reference the `src/index.js` file.
17+
18+
See the example for more information.
19+
920
## Specification
1021

1122
### Client
@@ -26,7 +37,7 @@ A server must return JSON from websocket requests in the following format:
2637

2738
As this is an array the server may return 0 or more elements that need to updated.
2839

29-
### Demo
40+
## Example
3041

3142
To run the example server use:
3243

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "tiny-browser-framework",
33
"description": "Minimal Client JS Framework",
4-
"version": "1.0.0",
4+
"version": "1.0.1",
55
"homepage": "https://github.com/thedumbterminal/TinyBrowserFramework",
66
"author": {
77
"name": "thedumbterminal",

0 commit comments

Comments
 (0)