Skip to content
This repository was archived by the owner on Oct 5, 2022. It is now read-only.

Commit 30d0599

Browse files
author
Maxime Vaillancourt
committed
add license and readme
1 parent 6db1db7 commit 30d0599

File tree

3 files changed

+99
-0
lines changed

3 files changed

+99
-0
lines changed

.gitignore

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,19 @@
22
npm-debug.log
33
.DS_Store
44
/*.env
5+
6+
lib-cov
7+
*.seed
8+
*.log
9+
*.csv
10+
*.dat
11+
*.out
12+
*.pid
13+
*.gz
14+
15+
pids
16+
logs
17+
results
18+
build
19+
20+
thumbs.db

LICENSE.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
The MIT License (MIT)
2+
3+
Copyright (c) 2017 Maxime Vaillancourt
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in
13+
all copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21+
THE SOFTWARE.

README.md

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
# JSON Feed Viewer
2+
3+
This is a webapp that allows to view JSON feeds. See it in action here: https://json-feed-viewer.herokuapp.com/
4+
5+
## Getting Started
6+
7+
1. Clone the repo
8+
9+
```
10+
git clone https://github.com/maximevaillancourt/json-feed-viewer.git
11+
```
12+
13+
2. Install dependencies
14+
15+
```
16+
cd json-feed-viewer && npm install
17+
```
18+
19+
3. Start the server
20+
21+
```
22+
npm start
23+
```
24+
25+
### Prerequisites
26+
27+
The app was tested on the following configuration.
28+
29+
- Ubuntu 16.04
30+
- NPM
31+
- Node v6.2.0+
32+
33+
## Deployment
34+
35+
The app is currently "Heroku deployment"-ready. Feel free to deploy it through other means.
36+
37+
## Contributing
38+
39+
Simply [create a new pull request](https://github.com/maximevaillancourt/json-feed-viewer/compare)! :)
40+
41+
## Built With
42+
43+
* [feed2json.org](https://feed2json.org/) - Used to convert RSS & Atom feeds into JSON
44+
* [Node](https://nodejs.org/en/) - JavaScript runtime based on Chrome's V8
45+
* [Express](https://expressjs.com/) - Minimalist web framework
46+
* [Bootswatch](https://bootswatch.com/) - Free themes for Bootstrap
47+
48+
## Authors
49+
50+
* **Maxime Vaillancourt** - *Initial work* - [maximevaillancourt](https://github.com/maximevaillancourt)
51+
52+
See also the list of [contributors](https://github.com/maximevaillancourt/json-feed-viewer/graphs/contributors) who participated in this project.
53+
54+
## License
55+
56+
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details
57+
58+
## Acknowledgments
59+
60+
* Andrew Chilton ([@andychilton](https://twitter.com/andychilton)) for developing feed2json.org
61+
* John Gruber ([@gruber](https://twitter.com/gruber)) for the initial exposure
62+
* Manton Reece ([@manton2](https://twitter.com/manton2)) & Brent Simmons ([@brentsimmons](https://twitter.com/brentsimmons)) for writing out the initial JSON Feed spec

0 commit comments

Comments
 (0)