yuanbiao
/
emqx
1
0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: add an actual README

This commit is contained in:
Stefan Strigler 2023-04-14 11:43:53 +02:00
parent 4f80690162
commit 90520a5382
1 changed files with 18 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

55
apps/emqx_utils/README.md
View File

@ -1,43 +1,24 @@
# [Application Name] - [Mandatory] # emqx_utils - Erlang utility library for EMQ X
> 0. App overview introduction
> 1. let people know what your project can do specifically. Is it a base
> library dependency, or what kind of functionality is provided to the user?
> 2. Provide context and add a link to any reference visitors might be
> unfamiliar with.
> 3. Design details, implementation technology architecture, Roadmap, etc.
# [Features] - [Optional] ## Overview
> A List of features your application provided. If the feature is quite simple, just
> list in the previous section.
# [Limitation] - [Optional] `emqx_utils` is a collection of utility functions for EMQ X, organized into
> Explain the limitations of the implementation used in your application. several modules. It provides various functionalities to make it easier to work
with EMQ X, such as binary manipulations, maps, JSON en- and decoding, ets table
handling, data conversions, and more.
# [Documention links] - [Mandatory] ## Features
> You can use the official docs link to provide a detailed explanation of
> the concept and functions of this application.
# [Installation] - [Optional] - `emqx_utils`: unsorted helper functions, formerly known as `emqx_misc` - NEEDS WORK
> How users can obtain this application. In most cases, this section is unnecessary. - `emqx_utils_api`: collection of helper functions for API responses
> Most of the applications are released with the EMQX distribution package. - `emqx_utils_binary`: binary reverse, join, trim etc
> Otherwise, it is necessary to provide step-by-step instructions on how - `emqx_utils_ets`: convenience functions for creating and looking up data in ets tables.
> to install this application. - `emqx_utils_json`: JSON encoding and decoding
- `emqx_utils_maps`: convenience functions for map lookup and manipulation like
deep_get etc.
# [Usage] - [Optional] ## Contributing
> This section explains how users can use the features provided by the application.
# [Basic Usage Guide] - [Optional] Please see our [contributing guidelines](../../CONTRIBUTING.md) for information
> Simple and reproducible introduction on how to use/start it. on how to contribute to `emqx_utils`. We welcome bug reports, feature requests,
and pull requests.
# [Configurations] - [Mandatory]
> Most important configurations that this application depends on.
> It would be best to attach official documentation if it's available.
# [HTTP APIs] - [Optional]
> Same as configuration.
# [Other] - [Optional]
> Other topics that users may need to know can be placed here.
# Contributing - [Mandatory]
Please see our [contributing.md](../../CONTRIBUTING.md).