Skip to content

Commit 37364b4

Browse files
committed
Update README.md
1 parent c44810b commit 37364b4

File tree

2 files changed

+28
-4
lines changed

2 files changed

+28
-4
lines changed

README.md

+28-4
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,40 @@
1-
# ohmy-hackernews
1+
<h1 align="center">:newspaper: ohmy-hackernews</h1>
22

3-
Personalized hackernews API client. Started as React tutorial [📓The Road to learn React](https://github.com/the-road-to-learn-react/the-road-to-learn-react). I found it quite useful, so added few tweaks to make it more handy and tailored for my needs. This is also a fully working sandbox project for testing new concepts and patterns used in React. :construction:
3+
<p align="center">
4+
<a href="https://opensource.org/licenses/mit-license.php">
5+
<img alt="MIT Licence" src="https://badges.frapsoft.com/os/mit/mit.svg?v=103" />
6+
</a>
7+
<a href="https://ohmy-hackernews.now.sh">
8+
<img alt="Website" src="https://img.shields.io/website?down_color=lightgrey&down_message=offline&style=plastic&up_color=green&up_message=online&url=https%3A%2F%2Fohmy-hackernews.now.sh%2F">
9+
</a>
10+
</p>
11+
<p align="center">
12+
<b>Personalized hackernews API client</b>
13+
</p>
14+
15+
<p align="center">
16+
<a href="https://ohmy-hackernews.now.sh">
17+
<b>ohmy-hackernews.now.sh </b>
18+
</a>
19+
</p>
20+
21+
Started as React.js tutorial [📓The Road to learn React](https://github.com/the-road-to-learn-react/the-road-to-learn-react). I found it quite useful, so added few tweaks to make it more handy and tailored for my needs. This is also a fully working sandbox project for testing new concepts and patterns used in modern React apps. :construction:
22+
23+
![screenshot](https://raw.githubusercontent.com/qaraluch/ohmy-hackernews/master/images/screenshot.png)
24+
25+
<br />
426

527
## Changelog
28+
29+
- Styling (material-ui)
630
- Refactored to hooks (rewrited API calls to custom hook)
7-
- Modularized app
31+
- Conde modularized
832

933
## Used template
1034

1135
The template project is [nano-react-app](https://github.com/adrianmcli/nano-react-app).
1236

1337
Use commands:
38+
1439
- `npm start` — This will spawn a development server with a default port of `1234`.
1540
- `npm run build` — This will output a production build in the `dist` directory.
16-

images/screenshot.png

53.9 KB
Loading

0 commit comments

Comments
 (0)