Skip to content

Commit 0523196

Browse files
authored
Update README (#2967)
1 parent da4baff commit 0523196

File tree

1 file changed

+17
-29
lines changed

1 file changed

+17
-29
lines changed

README.md

Lines changed: 17 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,27 @@
1-
[![Maven Central](https://maven-badges.herokuapp.com/maven-central/io.vavr/vavr/badge.png)](https://maven-badges.herokuapp.com/maven-central/io.vavr/vavr)
2-
[![Code Scene](https://img.shields.io/badge/codescene-analyzed-brightgreen.svg)](https://codescene.io/projects/981/jobs/latest-successful/results)
3-
[![Build Status](https://travis-ci.org/vavr-io/vavr.png)](https://travis-ci.org/vavr-io/vavr)
4-
[![codecov](https://codecov.io/gh/vavr-io/vavr/branch/master/graph/badge.svg)](https://codecov.io/gh/vavr-io/vavr)
5-
[![Sputnik](https://sputnik.ci/conf/badge)](https://sputnik.ci/app#/builds/vavr-io/vavr)
6-
[![Gitter Chat](https://badges.gitter.im/Join%20Chat.png)](https://gitter.im/vavr-io/vavr)
1+
# Vavr
2+
3+
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg?style=flat-square)](https://opensource.org/licenses/MIT)
4+
[![GitHub Release](https://img.shields.io/github/release/vavr-io/vavr.svg?style=flat-square)](https://github.com/vavr-io/vavr/releases)
5+
![Maven Central Version](https://img.shields.io/maven-central/v/io.vavr/vavr?versionPrefix=0)
6+
[![Build Status](https://github.com/vavr-io/vavr/actions/workflows/build.yml/badge.svg)](https://github.com/vavr-io/vavr/actions/workflows/build.yml)
7+
[![Code Coverage](https://codecov.io/gh/vavr-io/vavr/branch/master/graph/badge.svg)](https://codecov.io/gh/vavr-io/vavr)
78

89
```text
910
____ ______________ ________________________ __________
1011
\ \/ / \ \/ / __/ / \ \/ / \
1112
\______/___/\___\______/___/_____/___/\___\______/___/\___\
1213
```
1314

14-
# [Vavr](https://vavr.io/)
15-
16-
Vavr is an object-functional language extension to Java 8, which aims to reduce the lines of code and increase code quality.
17-
It provides persistent collections, functional abstractions for error handling, concurrent programming, pattern matching and much more.
15+
Vavr is an object-functional language extension to Java 8 that aims to reduce the number of lines of code and increase code quality.
16+
It provides persistent collections, functional abstractions for error handling, concurrent programming, pattern matching, and much more.
1817

1918
Vavr fuses the power of object-oriented programming with the elegance and robustness of functional programming.
2019
The most interesting part is a feature-rich, persistent collection library that smoothly integrates with Java's standard collections.
2120

22-
Because Vavr does not depend on any libraries (other than the JVM) you can easily add it as standalone .jar to your classpath.
21+
Because Vavr does not depend on any libraries (other than the JVM), you can easily add it as a standalone _.jar_ to your classpath.
2322

24-
To stay up to date please follow the [blog](http://blog.vavr.io).
23+
### Stargazers over time
24+
[![Stargazers over time](https://starchart.cc/vavr-io/vavr.svg?variant=adaptive)](https://starchart.cc/vavr-io/vavr)
2525

2626
## Using Vavr
2727

@@ -34,25 +34,13 @@ See [User Guide](http://docs.vavr.io) and/or [Javadoc](http://www.javadoc.io/doc
3434
* Executing code coverage report: `mvn -P ci clean test jacoco:report`
3535
* Create -javadoc.jar: `mvn javadoc:jar`
3636
* Create -source.jar: `mvn source:jar`
37-
* Update version properties: `mvn versions:update-properties`
38-
* Check for new plugin version: `mvn versions:display-plugin-updates`
39-
40-
### Benchmarks
41-
42-
Currently, only basic microbenchmarks are available. To run:
43-
44-
```bash
45-
mvn clean test -P benchmark -pl vavr-benchmark
46-
```
4737

4838
### Contributing
4939

50-
A small number of users have reported problems building Vavr. Read "How to Contribute" (CONTRIBUTING.md) for details.
51-
52-
---
40+
Currently, there are two significant branches:
41+
- `main` (represents a stream of work leading to the release of a new ma version)
42+
- `version/1.x` (historical work that went into `1.0.0-alpha-3`, treat is as read-only)
5343

54-
If you like Vavr you can support us by donating.
44+
If you're unsure which one to start with, start with `main`.
5545

56-
<a href="https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=8ZR8YCWB9K5WA">
57-
<img src="https://cloud.githubusercontent.com/assets/743833/23549988/02d66ccc-000f-11e7-8764-a257b21377bd.gif">
58-
</a>
46+
A small number of users have reported problems building Vavr. Read our [contribution guide](./CONTRIBUTING.md) for details.

0 commit comments

Comments
 (0)