From 37d2d29c8f5e3782207fe029bd26f35cee226f7b Mon Sep 17 00:00:00 2001 From: Toby Zerner Date: Wed, 21 Nov 2018 18:26:32 +1030 Subject: [PATCH] Update README, CONTRIBUTING --- framework/core/.github/CONTRIBUTING.md | 3 --- framework/core/CONTRIBUTING.md | 3 +++ framework/core/README.md | 32 ++++++++++++++++++++++---- 3 files changed, 30 insertions(+), 8 deletions(-) delete mode 100644 framework/core/.github/CONTRIBUTING.md create mode 100644 framework/core/CONTRIBUTING.md diff --git a/framework/core/.github/CONTRIBUTING.md b/framework/core/.github/CONTRIBUTING.md deleted file mode 100644 index 425788df1..000000000 --- a/framework/core/.github/CONTRIBUTING.md +++ /dev/null @@ -1,3 +0,0 @@ -# Contributing to Flarum - -Howdy! We're really excited that you are interested in contributing to Flarum. Before submitting your contribution, please take a moment and read through the [Contributing Guidelines](https://github.com/flarum/flarum/blob/master/CONTRIBUTING.md). diff --git a/framework/core/CONTRIBUTING.md b/framework/core/CONTRIBUTING.md new file mode 100644 index 000000000..c05d769d5 --- /dev/null +++ b/framework/core/CONTRIBUTING.md @@ -0,0 +1,3 @@ +# Contributing to Flarum + +Thank you for considering contributing to Flarum! Please read the **[Contributing guide](https://flarum.org/docs/contributing.html)** to learn how you can help. diff --git a/framework/core/README.md b/framework/core/README.md index c6b11ce5e..ed02120f3 100644 --- a/framework/core/README.md +++ b/framework/core/README.md @@ -1,11 +1,33 @@ -# Flarum Core +

-This repository contains Flarum's core code. If you want to set up a forum, visit the [main Flarum repository](https://github.com/flarum/flarum). +

+Build Status +Total Downloads +Latest Stable Version +License +

+ +## About Flarum + +**[Flarum](https://flarum.org/) is a delightfully simple discussion platform for your website.** It's fast and easy to use, with all the features you need to run a successful community. It is designed to be: + +* **Fast and simple.** No clutter, no bloat, no complex dependencies. Flarum is built with PHP so it’s quick and easy to deploy. The interface is powered by Mithril, a performant JavaScript framework with a tiny footprint. + +* **Beautiful and responsive.** This is forum software for humans. Flarum is carefully designed to be consistent and intuitive across platforms, out-of-the-box. + +* **Powerful and extensible.** Customize, extend, and integrate Flarum to suit your community. Flarum’s architecture is amazingly flexible, with a powerful Extension API. + +> **Note:** This repository contains Flarum's core code. If you want to set up a forum, visit the [main Flarum repository](https://github.com/flarum/flarum). ## Contributing -Flarum is open-source and we would love your help building it! Please read the [Contributing Guide](https://github.com/flarum/flarum/blob/master/CONTRIBUTING.md) to learn how you can help. +Thank you for considering contributing to Flarum! Please read the **[Contributing guide](https://flarum.org/docs/contributing.html)** to learn how you can help. -### Security Vulnerabilities +## Security Vulnerabilities + +If you discover a security vulnerability within Flarum, please send an e-mail to [security@flarum.org](mailto:security@flarum.org). All security vulnerabilities will be promptly addressed. + +## License + +Flarum is open-source software licensed under the [MIT License](https://github.com/flarum/flarum/blob/master/LICENSE). -If you discover a security vulnerability within Flarum, please send an email to [security@flarum.org](mailto:security@flarum.org).