Skip to content

Commit 6e5319f

Browse files
committed
Use "progress logs"/"progress monitors" instead of frontend/backend
1 parent 6057524 commit 6e5319f

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
1-
# ProgressLogging: a Logging-based progress bar frontend
1+
# ProgressLogging: a package for defining progress logs
22

33
[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://junolab.github.io/ProgressLogging.jl/stable)
44
[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://junolab.github.io/ProgressLogging.jl/dev)
55
[![Build Status](https://travis-ci.com/JunoLab/ProgressLogging.jl.svg?branch=master)](https://travis-ci.com/JunoLab/ProgressLogging.jl)
66
[![Codecov](https://codecov.io/gh/JunoLab/ProgressLogging.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/JunoLab/ProgressLogging.jl)
77
[![Coveralls](https://coveralls.io/repos/github/JunoLab/ProgressLogging.jl/badge.svg?branch=master)](https://coveralls.io/github/JunoLab/ProgressLogging.jl?branch=master)
88

9-
ProgressLogging.jl is a progress bar _frontend_. It can be used to
10-
report progress of a loop/loops with time-consuming body:
9+
ProgressLogging.jl is a package for defining _progress logs_. It can
10+
be used to report progress of a loop/loops with time-consuming body:
1111

1212
```julia
1313
julia> using ProgressLogging
@@ -17,9 +17,9 @@ julia> @progress for i in 1:10
1717
end
1818
```
1919

20-
This package is a _frontend_ in the sense using this package alone
21-
does not show any progress bars. You need to use one of the backends
22-
to view the progress.
20+
This package does not contain any _progress monitors_ for visualizing
21+
the progress of the program. You need to install a package supporting
22+
progress logs created by ProgressLogging.jl API. For example:
2323

2424
* [Juno](https://junolab.org/)
2525
* [ProgressMeterLogging.jl](https://github.com/tkf/ProgressMeterLogging.jl)

0 commit comments

Comments
 (0)