This is an automated email from the ASF dual-hosted git repository. ocket8888 pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/trafficcontrol.git
The following commit(s) were added to refs/heads/master by this push:
new 757b0eb9c3 Readme improvements (#6941)
757b0eb9c3 is described below
commit 757b0eb9c304d365d64838471c11138b24075d0c
Author: Eric Holguin <[email protected]>
AuthorDate: Wed Jul 6 17:45:49 2022 -0600
Readme improvements (#6941)
* Add more badges and links
* Updates per comments
* attempt at both logos depending on color scheme
* attempt 2
* add black text image
---
README.md | 60 ++++++++++++++++++++++++++++++++++++++++++++++++++----------
1 file changed, 50 insertions(+), 10 deletions(-)
diff --git a/README.md b/README.md
index 4ae73f27fb..9d53c5b0d5 100644
--- a/README.md
+++ b/README.md
@@ -17,24 +17,62 @@
under the License.
-->
-
-
-
-
-
-
-
+# Apache Traffic Control
+
+<picture>
+ <source media="(prefers-color-scheme: dark)"
srcset="https://traffic-control-cdn.readthedocs.io/en/latest/_static/ATC-SVG-FULL-WHITE.svg";>
+ <source media="(prefers-color-scheme: light)"
srcset="https://trafficcontrol.apache.org/resources/Traffic-Control-Logo-FINAL-Black-Text.png";>
+ <img alt="Traffic Control Logo"
src="https://trafficcontrol.apache.org/resources/Traffic-Control-Logo-FINAL-Black-Text.png";>
+</picture>
+
+Apache Traffic Control allows you to build a large scale content delivery
network using open source. Built around Apache Traffic Server as the caching
software, Traffic Control implements all the core functions of a modern CDN.
+
+[](https://s.apache.org/tc-slack-request)
+[](https://twitter.com/intent/follow?screen_name=trafficctrlcdn)
+[](https://www.youtube.com/channel/UC2zEj6sERinzx8w8uvyRBYg)
+
+[](https://github.com/apache/trafficcontrol/releases)
+
+__Build Status__
+
+[](https://github.com/apache/trafficcontrol/actions/workflows/ciab.yaml)
[](http://traffic-control-cdn.readthedocs.io/en/latest/?badge=latest)
-# Apache Traffic Control
-Apache Traffic Control is an Open Source implementation of a Content Delivery
Network.
+__Code Status__
+
+[](https://github.com/apache/trafficcontrol/actions/workflows/weasel.yml)
+[](https://github.com/apache/trafficcontrol/actions/workflows/go.fmt.yml)
+[](https://github.com/apache/trafficcontrol/actions/workflows/go.vet.yml)
[...]
+[](https://github.com/apache/trafficcontrol/actions/workflows/codeql.cpp.yml)
+[](https://github.com/apache/trafficcontrol/actions/workflows/codeql.go.yml)
+[](https://github.com/apache/trafficcontrol/actions/workflows/codeql.java.yml)
+[](https://github.com/apache/trafficcontrol/actions/workflows/codeql.javascript.yml)
+[](https://github.com/apache/trafficcontrol/actions/workflows/codeql.python.yml)
+
+__Test Status__
-## Documentation
+[](https://github.com/apache/trafficcontrol/actions/workflows/go.unit.tests.yaml)
+[](https://github.com/apache/trafficcontrol/actions/workflows/traffic-ops.yml)
+[](https://github.com/apache/trafficcontrol/actions/workflows/tp.integration.tests.yml)
+[](https://github.com/apache/trafficcontrol/actions/workflows/tm.integration.tests.yml)
+[](https://github.com/apache/trafficcontrol/actions/workflows/tr-ultimate-test-harness.yml)
+[](https://github.com/apache/trafficcontrol/actions/workflows/cache-config-tests.yml)
+[](https://github.com/apache/trafficcontrol/actions/workflows/health-client-tests.yml)
+
+## Documentation [^1]
* [Intro](http://traffic-control-cdn.readthedocs.io/en/latest/index.html)
* [CDN
Basics](http://traffic-control-cdn.readthedocs.io/en/latest/basics/index.html)
* [Traffic Control
Overview](http://traffic-control-cdn.readthedocs.io/en/latest/overview/index.html)
* [Administrator's
Guide](http://traffic-control-cdn.readthedocs.io/en/latest/admin/index.html)
* [Developer's
Guide](http://traffic-control-cdn.readthedocs.io/en/latest/development/index.html)
+* [Traffic Ops
API](https://traffic-control-cdn.readthedocs.io/en/latest/api/index.html)
+
+## Components [^1]
+* [Traffic
Ops](https://traffic-control-cdn.readthedocs.io/en/latest/overview/traffic_ops.html)
is the RESTful API service for management and monitoring of all servers in the
CDN.
+* [Traffic
Portal](https://traffic-control-cdn.readthedocs.io/en/latest/overview/traffic_portal.html)
is the web GUI for managing and monitoring the CDN via the Traffic Ops API.
+* [Traffic
Router](https://traffic-control-cdn.readthedocs.io/en/latest/overview/traffic_router.html)
uses DNS and HTTP302 to redirect clients to the closest available cache on the
CDN.
+* [Traffic
Monitor](https://traffic-control-cdn.readthedocs.io/en/latest/overview/traffic_monitor.html)
uses HTTP to poll the health of caches and provide this information to Traffic
Router.
+* [Traffic
Stats](https://traffic-control-cdn.readthedocs.io/en/latest/overview/traffic_stats.html)
acquires and stores real-time metrics and statistics into an InfluxDB for
charting and alerting.
## Releases
*
[https://github.com/apache/trafficcontrol/releases](https://github.com/apache/trafficcontrol/releases)
@@ -49,3 +87,5 @@ Apache Traffic Control is an Open Source implementation of a
Content Delivery Ne
* [Subscribe to our dev list](mailto:[email protected])
* [Search the email
archives](https://lists.apache.org/[email protected])
* [Check out the
wiki](https://cwiki.apache.org/confluence/display/TC/Traffic+Control+Home) for
less formal documentation, design docs and roadmap discussions
+
+[^1]: *Documentation links point to the __latest__ which is the unreleased
master branch and are neither stable nor necessarily accurate for any given
supported release.*
\ No newline at end of file
![https://traffic-control-cdn.readthedocs.io/en/latest/_static/ATC-SVG-FULL-WHITE.svg"](https://traffic-control-cdn.readthedocs.io/en/latest/_static/ATC-SVG-FULL-WHITE.svg"){kind=link}
![https://trafficcontrol.apache.org/resources/Traffic-Control-Logo-FINAL-Black-Text.png"](https://trafficcontrol.apache.org/resources/Traffic-Control-Logo-FINAL-Black-Text.png"){kind=link}
