Skip to content

Commit 5547b6e

Browse files
committed
chore: update main readme
1 parent 63436c6 commit 5547b6e

File tree

2 files changed

+49
-38
lines changed

2 files changed

+49
-38
lines changed

README.md

Lines changed: 49 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,61 +1,72 @@
1-
<p align="center"><img src="./assets/logo.png" width="60%"/></p>
1+
<p align="center">
2+
<img
3+
width="60%"
4+
src="./assets/logo.png"
5+
alt="Modern Web"
6+
/>
7+
</p>
28

3-
<h3 align="center">Developer tools for modern web development.</h3>
9+
<p align="center">
10+
<a href="https://github.com/modernweb-dev/actions"
11+
><img
12+
src="https://img.shields.io/github/workflow/status/modernweb-dev/web/Release/master?label=workflow&style=flat-square"
13+
alt="GitHub Actions workflow status"
14+
/></a>
15+
<a href="https://twitter.com/modern_web_dev"
16+
><img
17+
src="https://img.shields.io/badge/twitter-@modern_web_dev-1DA1F3?style=flat-square"
18+
alt="Follow @modern_web_dev on Twitter"
19+
/></a>
20+
</p>
421

5-
Modern browsers are a powerful platform for building websites and applications. Our goal is to teach developers what's available in the browser out of the box, and provide extensions in the form of patterns and tooling.
22+
<p align="center">
23+
<a href="https://modern-web.dev">Website</a>
24+
·
25+
<a href="https://modern-web.dev/guides/">Guides</a>
26+
·
27+
<a href="https://modern-web.dev/docs/">Documentation</a>
28+
</p>
629

7-
By building on top of established standards we can create solutions that are lightweight, easy to learn and remain relevant for a longer time.
30+
<h1></h1>
831

9-
## open-wc
32+
**Guides, tools and libraries for modern web development!**
1033

11-
Modern Web is a branch off from and started by the same team behind [open-wc](https://github.com/open-wc/open-wc/). For more information, [see this issue](https://github.com/open-wc/open-wc/issues/1681) at the open-wc repository.
34+
- **Built on web standards:** Work with and extend what's available in modern browsers, learning skills, and writing code that stays relevant.
35+
- **Lightweight:** Simple solutions that are lightweight and have a low barrier to entry. With extension points for power users.
36+
- **Low complexity:** Write code that is close to what actually runs in the browser, reducing abstractions and complexity.
1237

13-
## Test runner and dev server
38+
<p align="center">
39+
<a href="https://modern-web.dev/guides/"><strong>Explore the Modern Web Guides&nbsp;&nbsp;▶</strong></a>
40+
</p>
1441

15-
### Main packages
42+
## The goal for Modern Web
1643

17-
The main packages are the "opinionated" implementations of the test runner and dev server. Implementing a CLI and a good set default.
44+
> Our goal is to provide developers with the guides and tools they need to build for the modern web. We aim to work closely with the browser and avoid complex abstractions.
1845
19-
- [@web/test-runner](https://github.com/modernweb-dev/web/tree/master/packages/test-runner).
20-
- `@web/dev-server` (coming soon!)
46+
Modern browsers are **a powerful platform** for building websites and applications. We try to work with what's available in the browser first before reaching for custom solutions.
2147

22-
### Code transformation
48+
When you're **working with the browser** rather than against it, code, skills, and knowledge remain relevant for a longer time. Development becomes faster and debugging is easier because there are fewer layers of abstractions involved.
2349

24-
Plugins for transforming code in the dev server and test runner.
50+
At the same time, we are aware of the fact that not all problems can be solved elegantly by the browser today. We **support developers** making informed decisions about introducing tools and customizations to their projects, in such a way that developers can upgrade later as browser support improves.
2551

26-
- [@web/dev-server-rollup](https://github.com/modernweb-dev/web/tree/master/packages/dev-server-rollup)
27-
- [@web/dev-server-esbuild](https://github.com/modernweb-dev/web/tree/master/packages/dev-server-esbuild)
28-
- [@web/dev-server-legacy](https://github.com/modernweb-dev/web/tree/master/packages/dev-server-legacy)
52+
If you wanna know more see our [Announcement Blog Post](https://modern-web.dev/blog/introducing-modern-web/).
2953

30-
### Browser launchers
54+
## Our Products
3155

32-
Different implementations for controlling the browser to run tests in.
56+
- [Web Test Runner](https://modern-web.dev/docs/test-runner/overview/)
3357

34-
- [@web/test-runner-chrome](https://github.com/modernweb-dev/web/tree/master/packages/test-runner-chrome)
35-
- [@web/test-runner-puppeteer](https://github.com/modernweb-dev/web/tree/master/packages/test-runner-puppeteer)
36-
- [@web/test-runner-playwright](https://github.com/modernweb-dev/web/tree/master/packages/test-runner-playwright)
37-
- [@web/test-runner-selenium](https://github.com/modernweb-dev/web/tree/master/packages/test-runner-selenium)
38-
- [@web/test-runner-browserstack](https://github.com/modernweb-dev/web/tree/master/packages/test-runner-browserstack)
58+
There is much, much more to come so follow us on [Twitter](https://twitter.com/modern_web_dev).
3959

40-
### Test frameworks
60+
## 🤝 Contributing
4161

42-
Frameworks to run tests in the browser.
62+
We are always looking for contributors of all skill levels! If you're looking to ease your way into the project, try out a [good first issue](https://github.com/modernweb-dev/web/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22).
4363

44-
- [@web/test-runner-mocha](https://github.com/modernweb-dev/web/tree/master/packages/test-runner-mocha)
64+
If you are interested in helping contribute to Modern Web, please take a look at our [Contributing Guide](https://github.com/modernweb-dev/web/blob/master/CONTRIBUTING.md). Also, feel free to drop into [slack](https://modern-web.dev/discover/slack/) and say hi. 👋
4565

46-
### Testing helpers
66+
### Financial Contributors
4767

48-
Helper libraries for writing tests.
68+
Become a financial contributor and help us sustain our community. [[Contribute](https://opencollective.com/modern-web/contribute)]
4969

50-
- [@web/test-runner-commands](https://github.com/modernweb-dev/web/tree/master/packages/test-runner-commands)
51-
52-
### Other packages
53-
54-
Other packages implementing the low level parts. You will likely not use these directly, unless you're implementing your own tooling.
55-
56-
- [@web/test-runner-core](https://github.com/modernweb-dev/web/tree/master/packages/test-runner-core)
57-
- [@web/test-runner-cli](https://github.com/modernweb-dev/web/tree/master/packages/test-runner-cli)
58-
- [@web/test-runner-server](https://github.com/modernweb-dev/web/tree/master/packages/test-runner-server)
59-
- [@web/test-runner-coverage-v8](https://github.com/modernweb-dev/web/tree/master/packages/test-runner-coverage-v8)
70+
---
6071

6172
[![Testing Powered By SauceLabs](https://opensource.saucelabs.com/images/opensauce/powered-by-saucelabs-badge-white.png?sanitize=true 'Testing Powered By SauceLabs')](https://saucelabs.com)

assets/logo.png

7.11 KB
Loading

0 commit comments

Comments
 (0)