diff --git a/README.md b/README.md index e328194d2..63f544737 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,21 @@ -# opensource.twitter.dev +# Twitter Open Source [![status: active](https://opensource.twitter.dev/status/active.svg)](https://opensource.twitter.dev/status/#active) -This is the Twitter Open Source website at https://opensource.twitter.dev. +Twitter Open Source is a website that hosts open source projects developed by Twitter. The website is available at https://opensource.twitter.dev and is actively maintained. -This site is built with [hugo], using a custom built-in theme. Follow the -standard instructions on the hugo website to [install] and [run] hugo. Just -make sure to use hugo-extended, which has added support for Sass/SCSS -stylesheets. +## Technologies Used -There are also some python scripts that run periodically to [update some repo -data]. +The website is built using Hugo, a static site generator. It uses a custom built-in theme that is designed to match the Twitter brand. To run the website locally, follow the standard instructions provided on the Hugo website. Make sure to use the Hugo extended version, as it has added support for Sass/SCSS stylesheets. + +## Repo Data Update + +Periodically, some Python scripts run to update data related to the repositories hosted on Twitter Open Source. These scripts help keep the website up to date and provide the latest information to users [hugo]: https://gohugo.io/ [install]: https://gohugo.io/getting-started/installing/ [run]: https://gohugo.io/getting-started/usage/ [update some repo data]: ./.github/workflows/update-data.yml + +## Contributing +Twitter Open Source is an open-source project, and contributions from the community are welcome. If you want to contribute to the project, please read the contributing guidelines and follow the instructions provided.