Skip to content

Commit b08986c

Browse files
chore: update readme and bump version
1 parent fb71719 commit b08986c

2 files changed

Lines changed: 37 additions & 42 deletions

File tree

README.md

Lines changed: 35 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
21
[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/paanSinghCoder/OutFrontJS/LICENSE) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/paanSinghCoder/OutFrontJS#contributing)
32

43
<!-- PROJECT LOGO -->
@@ -9,7 +8,7 @@
98
</a>
109

1110
<h3 align="center">OutFront JS 🚀</h3>
12-
11+
1312

1413
<p align="center">
1514
Console for mobile browsers.
@@ -25,8 +24,6 @@
2524
</p>
2625
</p>
2726

28-
29-
3027
<!-- TABLE OF CONTENTS -->
3128
<!-- <details open="open"> -->
3229
<!-- <summary>Table of Contents</summary>
@@ -59,8 +56,8 @@
5956
<a href="https://www.producthunt.com/posts/outfront-js?utm_source=badge-featured&utm_medium=badge&utm_souce=badge-outfront-js" target="_blank"><img src="https://api.producthunt.com/widgets/embed-image/v1/featured.svg?post_id=299755&theme=light" alt="OutFront JS - Console log for mobile browsers. | Product Hunt" style="width: 250px; height: 54px;" width="250" height="54" /></a>
6057
</p>
6158

62-
6359
<!-- ABOUT THE PROJECT -->
60+
6461
## About The Project
6562

6663
<!-- ![demo-img](https://user-images.githubusercontent.com/9462473/121516034-6a315100-ca0b-11eb-8455-793ca024ec01.jpeg | width=100) -->
@@ -71,83 +68,83 @@ OutFront provides an onscreen console for mobile browsers 🔥
7168
Intercepts all your console.log, console.warn, console.error and errors and logs them into a popup on screen itself(DOM). This can be useful in scenarios where you don't have access to Chrome, Firefox, Edge etc. inspect panels.
7269

7370
Example scenario to use OutFront JS:
74-
* You want to debug your webapp in a mobile browser or Webview where access to console is not present. Example: Chinese mobile browsers.
75-
* You want your tester to see console.logs straight on the screen.
71+
72+
- You want to debug your webapp in a mobile browser or Webview where access to console is not present. Example: Chinese mobile browsers.
73+
- You want your tester to see console.logs straight on the screen.
7674

7775
OutFront JS intercepts following console methods currently:
78-
* `console.log`
79-
* `console.warn`
80-
* `console.error`
81-
* `Inbuilt Javascript errors`
8276

77+
- `console.log`
78+
- `console.warn`
79+
- `console.error`
80+
- `console.debug`
81+
- `console.info`
82+
- `Inbuilt Javascript errors`
8383

8484
<!-- GETTING STARTED -->
85+
8586
### Demo
8687

8788
A demo is worth a thousand words.
8889
[See demo](https://outfront-demo.netlify.app/)
8990

90-
91-
9291
### Built With
9392

94-
OutFront is extremely light weight and built with:
95-
* [JavaScript](https://developer.mozilla.org/en-US/docs/Web/JavaScript)
96-
93+
OutFront is extremely light weight and built with:
9794

95+
- [JavaScript](https://developer.mozilla.org/en-US/docs/Web/JavaScript)
9896

9997
<!-- GETTING STARTED -->
98+
10099
## Getting Started
101100

102101
OutFront **can be used with any web based projects and frameworks** such as React, Angular etc.
103102

104-
105103
### Installation
106104

107105
OutFront requires Node to be installed in order to use yarn/npm.
108-
* npm
109-
```sh
110-
npm install outfront
111-
```
112-
* yarn
113-
```sh
114-
yarn add outfront
115-
```
106+
107+
- npm
108+
```sh
109+
npm install outfront
110+
```
111+
- yarn
112+
```sh
113+
yarn add outfront
114+
```
116115

117116
<!-- USAGE EXAMPLES -->
117+
118118
## Usage
119119

120120
After installation import OutFront to your project and call `outfront()` function on the very top of project tree(for example index.js):
121121
122122
```jsx
123-
import React from 'react';
124-
import ReactDOM from 'react-dom';
125-
import App from './App';
123+
import React from 'react'
124+
import ReactDOM from 'react-dom'
125+
import App from './App'
126126
import outfront from 'outfront' // import outfront JS
127127

128128
outfront() // Call it on top of project.
129129

130-
ReactDOM.render(
131-
<HelloMessage name="Taylor" />,
132-
document.getElementById('container')
133-
);
130+
ReactDOM.render(<HelloMessage name="Taylor" />, document.getElementById('container'))
134131
```
135132

136-
```
137-
Note: Above example shows usage with React but, OutFront is built with vanilla JS and
133+
```
134+
Note: Above example shows usage with React but, OutFront is built with vanilla JS and
138135
can be practically used with any JS framework/library.
139136
```
140137

141138
<!-- ROADMAP -->
139+
142140
## Roadmap
143141

144142
See the [open issues](https://github.com/paansinghcoder/outfrontjs/issues) for the list of known issues.
145143

146144
See the [Product board](https://github.com/paanSinghCoder/OutFrontJS/projects/1) for the list of proposed features
147145

148-
149-
150146
<!-- CONTRIBUTING -->
147+
151148
## Contributing
152149

153150
**Consider starring this project on Github.**
@@ -160,12 +157,10 @@ Contributions are what make the open source community such an amazing place to b
160157
4. Push to the Branch (`git push origin feature/AmazingFeature`)
161158
5. Open a Pull Request
162159

163-
164-
165160
<!-- LICENSE -->
161+
166162
## License
167163

168164
Distributed under the MIT License. See `LICENSE` for more information.
169-
<div>Icon made by <a href="" title="iconixar">iconixar</a> from <a href="https://www.flaticon.com/" title="Flaticon">www.flaticon.com</a></div>
170-
171165

166+
<div>Icon made by <a href="" title="iconixar">iconixar</a> from <a href="https://www.flaticon.com/" title="Flaticon">www.flaticon.com</a></div>

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
{
22
"name": "outfront",
3-
"version": "1.1.2",
3+
"version": "1.2.0",
44
"type": "module",
5-
"description": "console logs, errors and warning on the screen",
5+
"description": "console logs, errors, debug, info and warning on the screen",
66
"main": "src/index.js",
77
"bin": "src/index.js",
88
"scripts": {

0 commit comments

Comments
 (0)