Skip to content

Commit 8601cad

Browse files
Update README.md
1 parent 73daff1 commit 8601cad

File tree

1 file changed

+7
-44
lines changed

1 file changed

+7
-44
lines changed

README.md

+7-44
Original file line numberDiff line numberDiff line change
@@ -22,50 +22,13 @@
2222
</p>
2323

2424

25-
<!-- TABLE OF CONTENTS -->
26-
<details open="open">
27-
<summary><h2 style="display: inline-block">Table of Contents</h2></summary>
28-
<ol>
29-
<li>
30-
<a href="#about-the-project">About The Project</a>
31-
</li>
32-
<li>
33-
<a href="#getting-started">Getting Started</a>
34-
<ul>
35-
<li><a href="#prerequisites">Prerequisites</a></li>
36-
<li><a href="#installation">Installation</a></li>
37-
</ul>
38-
</li>
39-
<li><a href="#roadmap">Roadmap</a></li>
40-
<li><a href="#contributing">Contributing</a></li>
41-
<li><a href="#license">License</a></li>
42-
<li><a href="#contact">Contact</a></li>
43-
</ol>
44-
</details>
45-
46-
47-
## About The Project
25+
# ℹ About The Project
4826

4927
The project contains a simple AWS lambda function that invokes an endpoint to start the caching process for feature statistics calculation.
5028

5129
It does not implement authentication, since the REST API does not contain any.
5230

53-
54-
<!-- GETTING STARTED -->
55-
## Getting Started
56-
57-
To get a local copy up and running follow these simple steps.
58-
59-
### Prerequisites
60-
61-
Installation for this project are described for linux. For other operating systems, please refer to the links provided.
62-
63-
* [Node.js](https://nodejs.org/en/)
64-
* [npm](http://npmjs.com/)
65-
66-
It is suggested to install Node.js and npm using [nvm](https://github.com/nvm-sh/nvm#install--update-script).
67-
68-
### Installation
31+
# 💽 Installation
6932

7033
To install, first clone the repository
7134

@@ -82,30 +45,30 @@ npm install
8245
The function is built to be invoked by AWS lambda. You can call it manually by calling the `startRequest` function in `index.js`.
8346

8447
<!-- ROADMAP -->
85-
## Roadmap
48+
# 🗺 Roadmap
8649

8750
See the [open issues](https://github.com/wifi-tracing/caching-function/issues) for a list of proposed features (and known issues).
8851

8952

9053
<!-- CONTRIBUTING -->
91-
## Contributing
54+
# 💁 Contributing
9255

9356
Contributions are what make the open source community such an amazing place to be learn, inspire, and create.
9457

9558

9659
The repo itself is just used to show the project. It is **NOT** actively maintained. The author suggests forking the project instead of opening new issues.
9760

9861
<!-- LICENSE -->
99-
## License
62+
# License
10063

10164
Distributed under the MIT License. See `LICENSE` for more information.
10265

10366
<!-- CONTACT -->
104-
## Contact
67+
# 🐦 Contact
10568

10669
Danilo Del Busso - [@danilo_delbusso](https://twitter.com/danilo_delbusso)
10770

108-
### Attributions
71+
# 🙏 Attributions
10972

11073
<div>Icons made by <a href="https://www.freepik.com" title="Freepik">Freepik</a> from <a href="https://www.flaticon.com/" title="Flaticon">www.flaticon.com</a></div>
11174

0 commit comments

Comments
 (0)