Skip to content

Commit bb9e76b

Browse files
committed
Updated ReadMe
1 parent df64abe commit bb9e76b

2 files changed

Lines changed: 16 additions & 7 deletions

File tree

README.md

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ ScreenshotCrew is an open-source screenshot as a service using [Puppeteer headle
1313
* https://screenshotmachine.com/
1414

1515
## Demo
16-
Coming soon at [https://screenshotcrew.com/](https://screenshotcrew.com/)
16+
[https://screenshotcrew.com/](https://screenshotcrew.com/)
1717

1818
## Installation
1919
```base
@@ -30,14 +30,24 @@ npm start
3030

3131
### Local
3232
```base
33-
nodemon app.js
33+
npm run-script dev
3434
```
3535

3636
## API Reference
37-
Reference will come soon!
37+
```bash
38+
curl --location --request GET "http://localhost:8080/api/capture?url=https://gaurangjadia.com"
39+
```
40+
41+
```bash
42+
curl --location --request POST "http://localhost:8080/api/capture" --header 'Content-Type: application/json' --data-raw '{
43+
"url": "https://gaurangjadia.com"
44+
}'
45+
```
3846

3947
## Tests
40-
Test case will come soon!
48+
```base
49+
npm test
50+
```
4151

4252
## License
4353
Please see the [license file](https://github.com/jadiagaurang/ScreenshotCrew/blob/main/LICENSE) for more information.

package.json

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@
44
"description": "ScreenshotCrew is an open-source screenshot as a service using Puppeteer headless browser. Using Node.js, Puppeteer and other plugins, ScreenshotCrew provides utility tool to create screenshot from any web page.",
55
"main": "app.js",
66
"scripts": {
7-
"dev": "nodemon app",
8-
"start": "node app",
7+
"dev": "nodemon app dev",
8+
"start": "node app prod",
99
"test": "mocha --timeout 90000 tests/*.js --exit"
1010
},
1111
"engines": {
@@ -29,7 +29,6 @@
2929
},
3030
"homepage": "https://github.com/jadiagaurang/ScreenshotCrew#readme",
3131
"devDependencies": {
32-
"chai": "^4.3.6",
3332
"mocha": "^10.0.0",
3433
"supertest": "^6.2.3"
3534
},

0 commit comments

Comments
 (0)