diff --git a/README.md b/README.md index b620c6376..8430091ce 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,57 @@ -# electron.atom.io +# electronjs.org -[![Greenkeeper badge](https://badges.greenkeeper.io/electron/electron.atom.io.svg)](https://greenkeeper.io/) +This is the source code for the Electron website at +[electronjs.org](https://electronjs.org). -This is the source code for the [Electron website](http://electron.atom.io). It's a static [Jekyll](https://jekyllrb.com) site hosted on [GitHub Pages](https://pages.github.com). +## Code of Conduct + +Electron is an open source project with a global contributor community. +We want everyone to feel safe in our community, and we welcome participation +from people of all backgrounds, regardless of experience level, age, gender +indentity, race, religion, or nationality. + +All participants are expected to uphold the [Code of Conduct](CODE_OF_CONDUCT.md). ## Contributing -- [Adding your app to electron.atom.io/apps](https://github.com/electron/electron-apps#adding-your-app) -- [Adding a meetup to electron.atom.io/community](CONTRIBUTING.md#meetups) -- [Improving the Electron documentation](CONTRIBUTING.md#documentation) +Writing code is great, but there are many other ways to make meaningful +contributions to the project: -For more info about how this site works and how to contribute, see [CONTRIBUTING.md](CONTRIBUTING.md). +- [Translate docs and website content](https://github.com/electron/electron-i18n) +- [Improve Electron tutorials](https://github.com/electron/electron/tree/master/docs) +- [Improve Electron API docs](https://github.com/electron/electron/tree/master/docs/api) +- [Add Electron apps to the site](https://github.com/electron/electron-apps#adding-your-app) + +If you just want to get the site up and running locally, here's the TLDR: + +``` +git clone https://github.com/electron/electronjs.org +cd electronjs.org +npm install +npm run dev +``` + +For more info about how this site works and how to contribute, see +[CONTRIBUTING.md](CONTRIBUTING.md), or jump straight to a specific topic below: + +- [Issues and Pull Requests](CONTRIBUTING.md#issues-and-pull-requests) +- [Heroku Review Apps](CONTRIBUTING.md#heroku-review-apps) +- [Running the Site](CONTRIBUTING.md#running-the-site) +- [Editing Content](CONTRIBUTING.md#content) + - [Documentation](CONTRIBUTING.md#documentation) + - [Apps](CONTRIBUTING.md#apps) + - [Blog](CONTRIBUTING.md#blog) + - [Localized Strings](CONTRIBUTING.md#localized-strings) + - [Translations](CONTRIBUTING.md#translations) +- [Routes](CONTRIBUTING.md#routes) +- [Middlware](CONTRIBUTING.md#middleware) +- [Views](CONTRIBUTING.md#views) +- [Context](CONTRIBUTING.md#context) +- [Styles](CONTRIBUTING.md#styles) +- [Fontend JavaScript](CONTRIBUTING.md#frontend-javascript) +- [Scripts](CONTRIBUTING.md#scripts) +- [Environment Variables](CONTRIBUTING.md#environment-variables) ## License -[MIT](LICENSE.md) +[MIT](LICENSE.md) \ No newline at end of file