Skip to content

Commit 4666abf

Browse files
committed
Readme
1 parent 60f2316 commit 4666abf

File tree

1 file changed

+49
-4
lines changed

1 file changed

+49
-4
lines changed

README.md

Lines changed: 49 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,52 @@
1-
# puppeteer-sharp
2-
Headless Chrome .NET API
3-
41
# Introduction
52

63
This project is a .NET port of the official [Node.JS Puppeteer API](https://github.com/GoogleChrome/puppeteer).
7-
The first goal is to get a functional library, following the same classes the Node.js version has.
4+
The first goal is to get a functional library with an API as close as the official one.
5+
6+
# Monthly reports
7+
8+
* [February 2018](http://www.hardkoded.com/blogs/puppeteer-sharp-monthly-february-2018)
9+
10+
# Roadmap
11+
Getting to all the 523 tests Puppeteer has, will be a long and fun journey. So, this will be the roadmap for Puppeteer Sharp 1.0:
12+
13+
## 0.1 First Minimum Viable Product
14+
The first 0.1 will include:
15+
* Browser download
16+
* Basic browser operations: create a browser, a page and navigate a page.
17+
* Take screenshots.
18+
* Print to PDF.
19+
20+
## 0.2 Repository cleanup
21+
This version won't include a new version. It will be about improving the repository:
22+
23+
* Setup CI.
24+
* Create basic documentation (Readme, contributing, code of conduct).
25+
26+
## 0.3 Puppeteer
27+
It will implement all [Puppeteer related tests](https://github.com/GoogleChrome/puppeteer/blob/master/test/test.js#L108)
28+
29+
## 0.4 Page
30+
It will implement all Page tests except the ones testing the evaluate method.
31+
As this will be quite a big version, I think we will publish many 0.3.X versions before 0.4.
32+
33+
## 0.5 Frames
34+
It will implement all Frame tests.
35+
36+
## 0.6 Simple interactions
37+
It will implement all the test related to setting values to inputs and clicking on elements.
38+
39+
## 0.X Intermediate versions
40+
At this point, We will have implemented most features, except the ones which are javascript related.
41+
I believe there will be many versions between 0.6 and 1.0.
42+
43+
## 1.0 Puppeteer the world!
44+
The 1.0 version will have all (or most) Puppeteer features implemented. I don't know if we'll be able to cover 100% of Puppeteer features, due to differences between both technologies, but we'll do our best.
45+
46+
# Progress
47+
48+
* Tests on Google's Puppeteer: 523
49+
* Tests on Puppeteer Sharp: 1
50+
* Passing tests: 1
51+
52+
I know, this sounds pretty lame, but we will get there.

0 commit comments

Comments
 (0)