From 1203e0ed739bbbf12166078738357fdb29a8c000 Mon Sep 17 00:00:00 2001 From: Pelle Wessman Date: Wed, 21 Aug 2024 21:00:08 +0200 Subject: [PATCH] docs: update README, LICENSE and fix outdated (#5197) --- LICENSE | 2 +- README.md | 28 ++++++++++++++-------------- docs/README.md | 14 +------------- 3 files changed, 16 insertions(+), 28 deletions(-) diff --git a/LICENSE b/LICENSE index 5c62253205..b114d5f113 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ (The MIT License) -Copyright (c) 2011-2022 OpenJS Foundation and contributors, https://openjsf.org +Copyright (c) 2011-2024 OpenJS Foundation and contributors, https://openjsf.org Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the diff --git a/README.md b/README.md index 59a7d4db74..0b2ef550df 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,25 @@

- Mocha test framework logo + Mocha test framework logo

☕️ Simple, flexible, fun JavaScript test framework for Node.js & The Browser ☕️

-

-GitHub Actions Build Status -Coverage Status -Chat - Discord -OpenCollective Sponsors -OpenCollective Backers -

+
-

NPM Version Node Version -

+[![GitHub Actions Build Status](https://github.com/mochajs/mocha/actions/workflows/mocha.yml/badge.svg)](https://github.com/mochajs/mocha/actions/workflows/mocha.yml) +Coverage Status + +
-


Mocha Browser Support h/t SauceLabs

+
+ +Chat - Discord +OpenCollective Sponsors +OpenCollective Backers + +
## Links @@ -68,6 +70,4 @@ Finally, come [chat with the maintainers on Discord](https://discord.gg/KeDn2uXh ## License -Copyright 2011-2022 OpenJS Foundation and contributors. Licensed [MIT](https://github.com/mochajs/mocha/blob/main/LICENSE). - -[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bhttps%3A%2F%2Fgithub.com%2Fmochajs%2Fmocha.svg?type=large)](https://app.fossa.io/projects/git%2Bhttps%3A%2F%2Fgithub.com%2Fmochajs%2Fmocha?ref=badge_large) +Copyright 2011-2024 OpenJS Foundation and contributors. Licensed [MIT](https://github.com/mochajs/mocha/blob/main/LICENSE). diff --git a/docs/README.md b/docs/README.md index 85687cea84..09f5e5857b 100644 --- a/docs/README.md +++ b/docs/README.md @@ -4,13 +4,9 @@ _So you wanna build the site?_ [mochajs.org](https://mochajs.org) is built using [Eleventy](https://www.11ty.io/), a simple static site generator. -## Prerequisites - -- Node.js v10.12.0 or greater - ## Development -1. Run `npm install` from working copy root to get Node.js deps. +1. Run `npm install` / `npm ci` from working copy root to get Node.js deps. 1. To serve the site and rebuild as changes are made, execute `npm run docs-watch`. 1. To rebuild the site _once_, execute `npm run docs`. @@ -19,11 +15,3 @@ _So you wanna build the site?_ - The content lives in `docs/index.md`; everything else is markup, scripts, assets, etc. - This file (`docs/README.md`) should _not_ be included in the build. - `docs/_site_` is where the deployed site lives. This directories are _not_ under version control. - -## License - -:copyright: 2016-2018 [JS Foundation](https://js.foundation) and contributors. - -Content licensed [CC-BY-4.0](https://raw.githubusercontent.com/mochajs/mocha/main/docs/LICENSE-CC-BY-4.0). - -Code licensed [MIT](https://raw.githubusercontent.com/mochajs/mocha/main/LICENSE-MIT).