Skip to content

Commit 4f59ec7

Browse files
committed
updated the README
1 parent d169240 commit 4f59ec7

File tree

2 files changed

+31
-2
lines changed

2 files changed

+31
-2
lines changed

README.md

Lines changed: 31 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,40 @@
1+
![paataka](screenshot.png)
2+
13
# Paataka
24

3-
A simple newsreader
5+
A simple newsreader written in golang, currently CLI-based
6+
7+
## Features
8+
9+
- Add publications and their RSS feeds
10+
- View their latest posts
11+
- Search through posts and find similar posts
12+
13+
## Releases
14+
15+
The [releases page](https://github.com/janithl/paataka/releases) has release
16+
notes and binaries for Linux and Mac OS
17+
18+
## Running/Building
19+
20+
Run `go run paataka.go` to run, and `go build paataka.go` to compile a binary
21+
22+
I use go's amazing built-in cross-compilation to build for different OSes and
23+
architectures. For example to build for Linux 386:
24+
25+
```
26+
env GOOS=linux GOARCH=386 go build paataka.go
27+
```
428

529
## To Run Tests
630

731
```
832
go test ./... -coverprofile=cover.out
933
```
1034

11-
To view the coverage report in HTML, install the tool `cover` and run `go tool cover -html=cover.out`
35+
To view the coverage report in HTML, install the tool `cover` and run
36+
`go tool cover -html=cover.out`
37+
38+
## License
39+
40+
Paataka is released under the [MIT License](http://opensource.org/licenses/MIT).

screenshot.png

13.4 KB
Loading

0 commit comments

Comments
 (0)