From d59e50ff1fa0c63fea378c1dc2e5f6b373de9cb4 Mon Sep 17 00:00:00 2001 From: kxu Date: Wed, 6 May 2020 11:55:20 -0700 Subject: [PATCH] Update README.md (#9731) * Update README.md Update and reorganize README to make it easier to navigate and use for community visitors. * Update README.md --- README.md | 231 ++++++++++++++++++++++++++++++------------------------ 1 file changed, 129 insertions(+), 102 deletions(-) diff --git a/README.md b/README.md index 141bddf85..afd966dd0 100644 --- a/README.md +++ b/README.md @@ -33,12 +33,19 @@ Superset width="500" /> -**Apache Superset** (incubating) is a modern, enterprise-ready -business intelligence web application +A modern, enterprise-ready business intelligence web application. + +[**Why Superset**](#why-superset) | +[**Database Support**](#database-support) | +[**Installation and Configuration**](#installation-and-configuration) | +[**Get Help**](#get-help) | +[**Contributor Guide**](#contributor-guide) | +[**Resources**](#resources) | +[**Superset Users**](#superset-users) | +[**License**](#license) | -Screenshots & Gifs ------------------- +## Screenshots & Gifs **View Dashboards** @@ -60,9 +67,7 @@ Screenshots & Gifs
-Apache Superset ---------------- -Apache Superset is a data exploration and visualization web application. +## Why Superset Superset provides: * An intuitive interface to explore and visualize datasets, and @@ -85,8 +90,7 @@ Superset provides: * Fast loading dashboards with configurable caching -Database Support ----------------- +## Database Support Superset speaks many SQL dialects through SQLAlchemy - a Python SQL toolkit that is compatible with most databases. A list of @@ -94,111 +98,134 @@ supported databases can be found [here](https://superset.incubator.apache.org/#databases). -Installation & Configuration ----------------------------- +## Installation and Configuration [See in the documentation](https://superset.incubator.apache.org/installation.html) -Resources -------------- -* [Mailing list](https://lists.apache.org/list.html?dev@superset.apache.org) -* [Docker image](https://hub.docker.com/r/preset/superset/) -* [Slides from Strata (March 2016)](https://drive.google.com/open?id=0B5PVE0gzO81oOVJkdF9aNkJMSmM) +## Get Help + * [Stackoverflow tag](https://stackoverflow.com/questions/tagged/apache-superset) -* [Join our Slack](https://join.slack.com/t/apache-superset/shared_invite/enQtNDMxMDY5NjM4MDU0LWJmOTcxYjlhZTRhYmEyYTMzOWYxOWEwMjcwZDZiNWRiNDY2NDUwNzcwMDFhNzE1ZmMxZTZlZWY0ZTQ2MzMyNTU) +* [Join Community Slack](https://join.slack.com/t/apache-superset/shared_invite/enQtNDMxMDY5NjM4MDU0LWJmOTcxYjlhZTRhYmEyYTMzOWYxOWEwMjcwZDZiNWRiNDY2NDUwNzcwMDFhNzE1ZmMxZTZlZWY0ZTQ2MzMyNTU) +* [Mailing list](https://lists.apache.org/list.html?dev@superset.apache.org) -Contributing ------------- +## Contributor Guide -Interested in contributing? Casual hacking? Check out -[Contributing.MD](https://github.com/apache/superset/blob/master/CONTRIBUTING.md) +Interested in contributing? Check out +[Contributing.MD](https://github.com/apache/superset/blob/master/CONTRIBUTING.md) to learn how to contribute and best practices. -Who uses Apache Superset (incubating)? --------------------------------------- +## Resources + +* [Blog](https://preset.io/blog/) +* [Docker image](https://hub.docker.com/r/preset/superset/) + +## Superset Users Here's a list of organizations that have taken the time to send a PR to let -the world know they are using Superset. Join our growing community! +the world know they are using Superset. If you are a user and want to be recognized, +all you have to do is file a simple PR [like this one](https://github.com/apache/incubator-superset/pull/7576). +Join our growing community! - 1. [6play](https://www.6play.fr) - 1. [AiHello](https://www.aihello.com) - 1. [Airbnb](https://github.com/airbnb) - 1. [Airboxlab](https://foobot.io) - 1. [Aktia Bank plc](https://www.aktia.com) - 1. [American Express](https://www.americanexpress.com) - 1. [Amino](https://amino.com) - 1. [Apollo GraphQL](https://www.apollographql.com/) - 1. [Ascendica Development](http://ascendicadevelopment.com) - 1. [Astronomer](https://www.astronomer.io) - 1. [bilibili](https://www.bilibili.com) - 1. [Brilliant.org](https://brilliant.org/) - 1. [Capital Service S.A.](http://capitalservice.pl) - 1. [Clark.de](http://clark.de/) - 1. [Cloudsmith](https://cloudsmith.io) - 1. [CnOvit](http://www.cnovit.com/) - 1. [Deepomatic](https://deepomatic.com/) - 1. [Dial Once](https://www.dial-once.com/en/) + 1. [6play](https://www.6play.fr) [@CoryChaplin] + 1. [AiHello](https://www.aihello.com) [@ganeshkrishnan1] + 1. [Airbnb](https://github.com/airbnb) + 1. [Airboxlab](https://foobot.io) [@antoine-galataud] + 1. [Aktia Bank plc](https://www.aktia.com) [@villebro] + 1. [American Express](https://www.americanexpress.com) [@TheLastSultan] + 1. [Amino](https://amino.com) [@shkr] + 1. [Apollo GraphQL](https://www.apollographql.com/) [@evans] + 1. [Ascendica Development](http://ascendicadevelopment.com) [@davidhassan] + 1. [Astronomer](https://www.astronomer.io) [@ryw] + 1. [bilibili](https://www.bilibili.com) [@Moinheart] + 1. [Brilliant.org](https://brilliant.org/) + 1. [Capital Service S.A.](http://capitalservice.pl) [@pkonarzewski] + 1. [Clark.de](http://clark.de/) + 1. [Cloudsmith](https://cloudsmith.io) [@alancarson] + 1. [CnOvit](http://www.cnovit.com/) [@xieshaohu] + 1. [Deepomatic](https://deepomatic.com/) [@Zanoellia] + 1. [Dial Once](https://www.dial-once.com/en/) 1. [Digit Game Studios](https://www.digitgaming.com/) - 1. [Douban](https://www.douban.com/) - 1. [Dragonpass](https://www.dragonpass.com.cn/) - 1. [Dremio](https://dremio.com) - 1. [Endress+Hauser](http://www.endress.com/) - 1. [Faasos](http://faasos.com/) - 1. [Fanatics](https://www.fanatics.com) - 1. [FBK - ICT center](http://ict.fbk.eu) - 1. [Fordeal](http://www.fordeal.com) - 1. [GFG - Global Fashion Group](https://global-fashion-group.com) - 1. [GfK Data Lab](http://datalab.gfk.com) - 1. [Grassroot](https://www.grassrootinstitute.org/) - 1. [Hostnfly](https://www.hostnfly.com/) - 1. [HuiShouBao](http://www.huishoubao.com/) - 1. [Intercom](https://www.intercom.com/) - 1. [jampp](https://jampp.com/) - 1. [komoot](https://www.komoot.com/) - 1. [Konfío](http://konfio.mx) - 1. [Kuaishou](https://www.kuaishou.com/) - 1. [Let's Roam](https://www.letsroam.com/) - 1. [Lime](https://www.limebike.com/) - 1. [Living Goods](https://www.livinggoods.org) - 1. [Lyft](https://www.lyft.com/) - 1. [Maieutical Labs](https://maieuticallabs.it) - 1. [Myra Labs](http://www.myralabs.com/) - 1. [Now](https://www.now.vn/) - 1. [Ona](https://ona.io) - 1. [Peak AI](https://www.peak.ai/) - 1. [PeopleDoc](https://www.people-doc.com) - 1. [Popoko VM Games Studio](https://popoko.live) - 1. [Preset, Inc.](https://preset.io) - 1. [Pronto Tools](http://www.prontotools.io) - 1. [PubNub](https://pubnub.com) - 1. [QPID Health](http://www.qpidhealth.com/) - 1. [Qunar](https://www.qunar.com/) - 1. [Rakuten Viki](https://www.viki.com) - 1. [Reward Gateway](https://www.rewardgateway.com) - 1. [Safaricom](https://www.safaricom.co.ke/) - 1. [Scoot](https://scoot.co/) - 1. [ScopeAI](https://www.getscopeai.com) - 1. [Shopee](https://shopee.sg) - 1. [Shopkick](https://www.shopkick.com) - 1. [Showmax](https://tech.showmax.com) - 1. [source{d}](https://www.sourced.tech) - 1. [Steamroot](https://streamroot.io/) - 1. [Tails.com](https://tails.com) - 1. [Tenable](https://www.tenable.com) - 1. [THE ICONIC](http://theiconic.com.au/) - 1. [timbr.ai](https://timbr.ai/) - 1. [TME QQMUSIC/WESING](https://www.tencentmusic.com/) - 1. [Tobii](http://www.tobii.com/) - 1. [Tooploox](https://www.tooploox.com/) - 1. [TrustMedis](https://trustmedis.com) - 1. [Twitter](https://twitter.com/) - 1. [Udemy](https://www.udemy.com/) - 1. [VIPKID](https://www.vipkid.com.cn/) - 1. [WeSure](https://www.wesure.cn/) - 1. [Windsor.ai](https://www.windsor.ai/) - 1. [Yahoo!](https://yahoo.com/) + 1. [Douban](https://www.douban.com/) [@luchuan] + 1. [Dragonpass](https://www.dragonpass.com.cn/) [@zhxjdwh] + 1. [Dremio](https://dremio.com) [@narendrans] + 1. [Endress+Hauser](http://www.endress.com/) [@rumbin] + 1. [Faasos](http://faasos.com/) [@shashanksingh] + 1. [Fanatics](https://www.fanatics.com) [@coderfender] + 1. [FBK - ICT center](http://ict.fbk.eu) + 1. [Fordeal](http://www.fordeal.com) [@Renkai] + 1. [GFG - Global Fashion Group](https://global-fashion-group.com) [@ksaagariconic] + 1. [GfK Data Lab](http://datalab.gfk.com) [@mherr] + 1. [Grassroot](https://www.grassrootinstitute.org/) + 1. [Hostnfly](https://www.hostnfly.com/) [@alexisrosuel] + 1. [HuiShouBao](http://www.huishoubao.com/) [@Yukinoshita-Yukino] + 1. [Intercom](https://www.intercom.com/) [@kate-gallo] + 1. [jampp](https://jampp.com/) + 1. [komoot](https://www.komoot.com/) [@christophlingg] + 1. [Konfío](http://konfio.mx) [@uis-rodriguez] + 1. [Kuaishou](https://www.kuaishou.com/) [@zhaoyu89730105] + 1. [Let's Roam](https://www.letsroam.com/) + 1. [Lime](https://www.limebike.com/) [@cxmcc] + 1. [Living Goods](https://www.livinggoods.org) [@chelule] + 1. [Lyft](https://www.lyft.com/) + 1. [Maieutical Labs](https://maieuticallabs.it) [@xrmx] + 1. [Myra Labs](http://www.myralabs.com/) [@viksit] + 1. [Now](https://www.now.vn/) [@davidkohcw] + 1. [Ona](https://ona.io) [@pld] + 1. [Peak AI](https://www.peak.ai/) [@azhar22k] + 1. [PeopleDoc](https://www.people-doc.com) [@rodo] + 1. [Popoko VM Games Studio](https://popoko.live) + 1. [Preset, Inc.](https://preset.io) + 1. [Pronto Tools](http://www.prontotools.io) [@zkan] + 1. [PubNub](https://pubnub.com) [@jzucker2] + 1. [QPID Health](http://www.qpidhealth.com/) + 1. [Qunar](https://www.qunar.com/) [@flametest] + 1. [Rakuten Viki](https://www.viki.com) + 1. [Reward Gateway](https://www.rewardgateway.com) + 1. [Safaricom](https://www.safaricom.co.ke/) [@mmutiso] + 1. [Scoot](https://scoot.co/) [@haaspt] + 1. [ScopeAI](https://www.getscopeai.com) [@iloveluce] + 1. [Shopee](https://shopee.sg) [@xiaohanyu] + 1. [Shopkick](https://www.shopkick.com) [@LAlbertalli] + 1. [Showmax](https://tech.showmax.com) [@bobek] + 1. [source{d}](https://www.sourced.tech) [@marnovo] + 1. [Steamroot](https://streamroot.io/) + 1. [Tails.com](https://tails.com) [@alanmcruickshank] + 1. [Tenable](https://www.tenable.com) [@dflionis] + 1. [THE ICONIC](http://theiconic.com.au/) [@ksaagariconic] + 1. [timbr.ai](https://timbr.ai/) [@semantiDan] + 1. [TME QQMUSIC/WESING](https://www.tencentmusic.com/) + 1. [Tobii](http://www.tobii.com/) [@dwa] + 1. [Tooploox](https://www.tooploox.com/) [@jakubczaplicki] + 1. [TrustMedis](https://trustmedis.com) [@famasya] + 1. [Twitter](https://twitter.com/) + 1. [Udemy](https://www.udemy.com/) [@sungjuly] + 1. [VIPKID](https://www.vipkid.com.cn/) [@illpanda] + 1. [WeSure](https://www.wesure.cn/) + 1. [Windsor.ai](https://www.windsor.ai/) [@octaviancorlade] + 1. [Yahoo!](https://yahoo.com/) 1. [Zaihang](http://www.zaih.com/) - 1. [Zalando](https://www.zalando.com) - 1. [Zalora](https://www.zalora.com) + 1. [Zalando](https://www.zalando.com) [@dmigo] + 1. [Zalora](https://www.zalora.com) [@ksaagariconic] + +## License + +``` +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +```