Skip to content

Commit 5ac179e

Browse files
committed
Updating to use standard object and add docs
1 parent 42907bc commit 5ac179e

File tree

10 files changed

+1646
-122
lines changed

10 files changed

+1646
-122
lines changed

.gitignore

Lines changed: 35 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,39 @@
11
nimcache
2-
.env
32
tests/*
43
!tests/*.nim
54
!tests/nim.cfg
6-
.vscode
5+
src/*
6+
!src/*.nim
7+
!src/*.cfg
8+
nimsuggest.log
9+
10+
.vscode
11+
12+
## Mac stuff
13+
14+
*.DS_Store
15+
.AppleDouble
16+
.LSOverride
17+
18+
# Icon must end with two \r
19+
Icon
20+
21+
22+
# Thumbnails
23+
._*
24+
25+
# Files that might appear in the root of a volume
26+
.DocumentRevisions-V100
27+
.fseventsd
28+
.Spotlight-V100
29+
.TemporaryItems
30+
.Trashes
31+
.VolumeIcon.icns
32+
.com.apple.timemachine.donotpresent
33+
34+
# Directories potentially created on remote AFP share
35+
.AppleDB
36+
.AppleDesktop
37+
Network Trash Folder
38+
Temporary Items
39+
.apdisk

README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,21 @@ A simple progress bar for Nim.
44

55
![Demo](https://raw.githubusercontent.com/euantorano/progress.nim/master/progress.gif)
66

7+
## Installation
8+
9+
```
10+
nimble install progress
11+
```
12+
13+
## [API Documentation](https://htmlpreview.github.io/?https://github.com/euantorano/progress.nim/blob/master/docs/progress.html)
714

815
## Usage
916

1017
```nim
1118
# os is only needed for `sleep`
1219
import progress, os
1320
14-
let bar = newProgressBar()
15-
21+
var bar = newProgressBar()
1622
bar.start()
1723
1824
for i in 1..100:

0 commit comments

Comments
 (0)