You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@apisix.apache.org by sp...@apache.org on 2022/06/06 06:14:11 UTC

[apisix-docker] branch master updated: Add Quick Reference and License section (#312)

This is an automated email from the ASF dual-hosted git repository.

spacewander pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/apisix-docker.git


The following commit(s) were added to refs/heads/master by this push:
     new 5f0a789  Add Quick Reference and License section (#312)
5f0a789 is described below

commit 5f0a7891a45c8d9cdfd20049e2cb74bb1b104efb
Author: Violet (Xinyi) Zhou <66...@users.noreply.github.com>
AuthorDate: Sun Jun 5 23:14:07 2022 -0700

    Add Quick Reference and License section (#312)
    
    Co-authored-by: Yilin Zeng <36...@users.noreply.github.com>
---
 README.md | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)

diff --git a/README.md b/README.md
index 069d144..1b7efd3 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,18 @@
+## Quick Reference
+
+- Documentation: \
+  [the APISIX Docs](https://apisix.apache.org/docs/apisix/next/getting-started/)
+
+- Where to file issues: \
+  [https://github.com/apache/apisix/issues](https://github.com/apache/apisix/issues)
+
+- Where to get help related to Apache APISIX: \
+  Mailing List: Mail to dev-subscribe@apisix.apache.org, follow the reply to subscribe to the mailing list.
+  Slack Workspace - join [#apisix channel](https://apisix.apache.org/docs/general/join/#join-the-slack-channel)
+
+- Blog: \
+  [the APISIX Blog](https://apisix.apache.org/blog/)
+
 ## What is APISIX
 
 Apache APISIX is a dynamic, real-time, high-performance API gateway. APISIX provides rich traffic management features such as load balancing, dynamic upstream, canary release, circuit breaking, authentication, observability, and more.
@@ -168,3 +183,9 @@ To minimize the image size, additional tools, such as git and bash, are not incl
 This image is based on the CentOS Linux project, available in the centos official image. CentOS is derived from the sources of Red Hat Enterprise Linux (RHEL). It is considered to be a more stable distribution compared to Ubuntu, mainly because package updates are less frequent.
 
 The variant is useful when your primary concern is stability and want to minimize the number of image updates. The applications running on CentOS don't need to be updated as often owing to the lesser frequency of its updates, and the cost is also very less than compared with other Linux essentials.
+
+## License
+
+Licensed under the Apache License, Version 2.0: [http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)
+
+As with all Docker images, these likely also contain other software which may be under other licenses (such as Bash, etc from the base distribution, along with any direct or indirect dependencies of the primary software being contained).