diff --git a/README.md b/README.md index 4ea254e3a..d3c5cc65a 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,25 @@ # 30 seconds of code -30 seconds of code is an accessible high-quality knowledge base for developers of all skill levels, established in 2017. Since then, we have created hundreds of short code snippets and programming articles with the help of a large community of contributors. Our goal is to make software development more accessible and help the open source community thrive by helping people learn to code. +> Short JavaScript code snippets for all your development needs -* Visit [our website](https://30secondsofcode.org) to view our snippet collection and find code snippets that suit your needs. -* Learn more about our team on our [about page](https://www.30secondsofcode.org/about) or explore frequently asked questions on our [FAQ page](https://www.30secondsofcode.org/faq). -* Follow us on [Twitter](https://twitter.com/30secondsofcode) for daily short code snippets and project updates. +* Visit [our website](https://30secondsofcode.org) to view our snippet collection. +* Use the [Search page](https://30secondsofcode.org/search) to find snippets that suit your needs. You can search by name, tag, language or using a snippet's description. Just start typing a term and see what comes up. +* Browse the [JavaScript Snippet collection](https://30secondsofcode.org/js/p/1) to see all the snippets in this project or click individual tags at the top of the same page to narrow down your search to a specific tag. +* Click on each snippet card to view the whole snippet, including code, explanation and examples. +* You can use the button at the bottom of a snippet card to copy the code to clipboard. +* If you like the project, give it a star. It means a lot to the people maintaining it. + +## Want to contribute? + +* If you want to help us improve, take a minute to read the [Contribution Guidelines](/CONTRIBUTING.md) first. +* Use the [Snippet Template](/snippet-template.md) to add new snippets to the collection. +* If you find a problem with a specific snippet, please [open an issue](https://github.com/30-seconds/30-seconds-of-code/issues/new). +* If you find a problem with the website, please [report it in the web repository](https://github.com/30-seconds/30-seconds-web/issues/new). + +## Credits + +* This repository is maintained by the [30 seconds of code organization on GitHub](https://github.com/30-seconds). +* All snippets are licensed under the CC-BY-4.0 License, unless explicitly stated otherwise. +* Logos, names and trademarks are not to be used without the explicit consent of the owners of the 30 seconds of code GitHub organization. +* Our website is powered by [Netlify](https://www.netlify.com/), [Next.js](https://nextjs.org/) & [GitHub](https://github.com/).