Skip to content

Commit 7b2069f

Browse files
committed
add project description to README.md
1 parent b8e032d commit 7b2069f

File tree

1 file changed

+33
-1
lines changed

1 file changed

+33
-1
lines changed

README.md

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,36 @@
11
### Hexlet tests and linter status:
22
[![Actions Status](https://github.com/ExpCoderWeb/fullstack-javascript-project-11/actions/workflows/hexlet-check.yml/badge.svg)](https://github.com/ExpCoderWeb/fullstack-javascript-project-11/actions) [![lint](https://github.com/ExpCoderWeb/fullstack-javascript-project-11/actions/workflows/lint.yml/badge.svg)](https://github.com/ExpCoderWeb/fullstack-javascript-project-11/actions/workflows/lint.yml)
33

4-
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=ExpCoderWeb_fullstack-javascript-project-11&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=ExpCoderWeb_fullstack-javascript-project-11)
4+
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=ExpCoderWeb_fullstack-javascript-project-11&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=ExpCoderWeb_fullstack-javascript-project-11)
5+
6+
### Brief introduction
7+
There is a special format representing web news feeds, article annotations, and other content called **RSS**. This is the easiest way for websites (usually blogs) to enable users to subscribe to updates. For this purpose, special services called RSS aggregators are used. These services can check RSS web feeds for updates and conveniently display them, marking what they have read, and so on.
8+
9+
### Project overview
10+
**RSS Reader** is a RSS feeds aggregator that provides the ability to add an infinite number of RSS feeds. The content of each feed is automatically updated every 5 seconds and new posts are included to the main stream.
11+
12+
### Requirements:
13+
- Unix terminal
14+
- Node.js: 18.x or higher
15+
16+
### Setup
17+
```bash
18+
git clone git@github.com:ExpCoderWeb/fullstack-javascript-project-11.git
19+
```
20+
21+
```bash
22+
cd fullstack-javascript-project-11
23+
```
24+
25+
```bash
26+
make install
27+
```
28+
Then, there are 2 options:
29+
30+
`make develop` - _for local launch_
31+
32+
`make build` - _for application build_
33+
34+
### Usage
35+
You can try the service on the following link:
36+
[RSS Reader](https://rss-reader-kxbrjeqp0-expcoderwebs-projects-534e6897.vercel.app/)

0 commit comments

Comments
 (0)