Skip to content

Commit 29d2958

Browse files
committed
Readme updates
1 parent 7d2b87d commit 29d2958

File tree

2 files changed

+21
-9
lines changed

2 files changed

+21
-9
lines changed

README.md

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -88,13 +88,18 @@ This library contains a variety of concurrency abstractions at high and low leve
8888
* [Software transactional memory](http://ruby-concurrency.github.io/concurrent-ruby/Concurrent/TVar.html) (TVar)
8989
* [ReadWriteLock](http://ruby-concurrency.github.io/concurrent-ruby/Concurrent/ReadWriteLock.html)
9090

91-
### Experimental features
91+
### Edge features
9292

93-
These features are under active, experimental development and may change frequently. They are minimally
94-
documented and tested. They are available in the `concurrent-ruby-experimental` companion gem.
93+
They are available in the `concurrent-ruby-edge` companion gem, install with `gem install concurrent-ruby-edge`.
9594

96-
* [Actor](http://ruby-concurrency.github.io/concurrent-ruby/Concurrent/Actor.html): Implements the Actor Model, where concurrent actors exchange messages.
97-
* [Channel](http://ruby-concurrency.github.io/concurrent-ruby/Concurrent/Channel.html): Communicating Sequential Processes (CSP).
95+
These features are under active development and may change frequently. They are expected not to
96+
keep backward compatibility (there may also lack tests and documentation). Semantic versions will
97+
be obeyed though. Features developed in `concurrent-ruby-edge` are expected to move to `concurrent-ruby` when final.
98+
99+
* [Actor](http://ruby-concurrency.github.io/concurrent-ruby/Concurrent/Actor.html):
100+
Implements the Actor Model, where concurrent actors exchange messages.
101+
* [Channel](http://ruby-concurrency.github.io/concurrent-ruby/Concurrent/Channel.html):
102+
Communicating Sequential Processes (CSP).
98103

99104
## Usage
100105

@@ -132,7 +137,7 @@ require 'concurrent/scheduled_task' # Concurrent::ScheduledTask
132137
require 'concurrent/timer_task' # Concurrent::TimerTask
133138
require 'concurrent/tvar' # Concurrent::TVar
134139

135-
# experimental - available in `concurrent-ruby-experimental` companion gem
140+
# experimental - available in `concurrent-ruby-edge` companion gem
136141

137142
require 'concurrent/actor' # Concurrent::Actor and supporting code
138143
require 'concurrent/channel ' # Concurrent::Channel and supporting code
@@ -156,8 +161,8 @@ and run `bundle install` from your shell.
156161

157162
Potential performance improvements may be achieved under MRI by installing optional C extensions.
158163
To minimize installation errors the C extensions are available in the `concurrent-ruby-ext` extension
159-
gem. The extension gem lists `concurrent-ruby` as a dependency so it is not necessary to install both.
160-
Simply install the extension gen:
164+
gem. `concurrent-ruby` and `concurrent-ruby-ext` are always released together with same version.
165+
Simply install the extension gen too:
161166

162167
```ruby
163168
gem install concurrent-ruby-ext

concurrent-ruby-edge.gemspec

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,14 @@ Gem::Specification.new do |s|
1010
s.authors = ["Jerry D'Antonio", 'The Ruby Concurrency Team']
1111
1212
s.homepage = 'http://www.concurrent-ruby.com'
13-
s.summary = 'Experimental features and additions to the concurrent-ruby gem. Minimally tested and documented.'
13+
s.summary = <<-TXT
14+
Edge features and additions to the concurrent-ruby gem.
15+
16+
These features are under active development and may change frequently. They are expected not to
17+
keep backward compatibility (there may also lack tests and documentation). Semantic versions will
18+
be obeyed though. Features developed in `concurrent-ruby-edge` are expected to move to `concurrent-ruby` when final.
19+
TXT
20+
1421
s.license = 'MIT'
1522
s.date = Time.now.strftime('%Y-%m-%d')
1623

0 commit comments

Comments
 (0)