Skip to content
This repository was archived by the owner on Jul 2, 2021. It is now read-only.

Commit 0260a6c

Browse files
author
Florian Dewulf
committed
Update README and the travis file
1 parent e068d7d commit 0260a6c

File tree

2 files changed

+9
-8
lines changed

2 files changed

+9
-8
lines changed

.travis.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ stages:
1616
- name: npm release
1717
if: tag =~ /^\d+\.\d+\.\d+$/
1818
after_script:
19-
- ./cc-test-reporter after-build lcov --exit-code $TRAVIS_TEST_RESULT
19+
- ./cc-test-reporter after-build format-coverage -t lcov --exit-code $TRAVIS_TEST_RESULT
2020
jobs:
2121
include:
2222
- stage: npm release

README.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,18 @@
1-
### :warning: WORK IN PROGRESS :warning:
2-
31
# 🍒 Cherry
42

53
[![Build Status](https://travis-ci.com/Lund-Org/cherry.svg?branch=master)](https://travis-ci.com/Lund-Org/cherry)
64

75
Cherry is a lightweight framework to quickly generate a web server
86

9-
## Installation
7+
## :electric_plug: Installation
108

119
Use the package manager [npm](http://npmjs.com) to install Cherry.
1210

1311
```bash
1412
npm install @lund-org/cherry
1513
```
1614

17-
## Usage
15+
## :wrench: Usage
1816

1917
Checkout the example in the [example folder](https://github.com/Lund-Org/cherry/tree/master/example).
2018

@@ -24,7 +22,7 @@ openssl req -x509 -newkey rsa:4096 -keyout key.pem -out cert.pem -days 365 -node
2422
```
2523
Warning : It doesn't work on Windows, you will only get the key.pem
2624

27-
## To do list
25+
## :scroll: To do list
2826

2927
- [x] [Response management, including view (default), download and json (a builtin helper)](https://github.com/Lund-Org/cherry/issues/1)
3028
- [x] [Templating management (a base for the plugins)](https://github.com/Lund-Org/cherry/issues/2)
@@ -35,10 +33,13 @@ Warning : It doesn't work on Windows, you will only get the key.pem
3533
- [ ] [Plugin management](https://github.com/Lund-Org/cherry/issues/7)
3634
- [ ] [Release and deployment workflow](https://github.com/Lund-Org/cherry/issues/8)
3735

38-
## Contributing
36+
## :open_file_folder: Resources
37+
- [Cherry Handlebars connector](https://github.com/Lund-Org/cherry-handlebars-connector) : The plugin which use [handlebars](https://handlebarsjs.com/) as the view engine
38+
39+
## :pencil2: Contributing
3940
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
4041

4142
Please make sure to update tests as appropriate.
4243

43-
## License
44+
## :book: License
4445
[MIT](https://github.com/Lund-Org/cherry/blob/master/LICENSE)

0 commit comments

Comments
 (0)