polyphony 0.99.3 → 0.99.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9b360daaa49eebb84f08c16ddf8ba2bc6b936f4ce5f5247ec223d80dbd484a77
-  data.tar.gz: cc903ca6277df22c91fe2e72de523890b89f3c1e74eec69f0965f5b2f03665a7
+  metadata.gz: bd44b14a67b4f5aedd2f46010ff0ca790072f7c5261c6b6c53b622667264cec9
+  data.tar.gz: 9bcc853cbbb8f03e4fc7370b957f5895d78f36fece297d130451d8fef37da782
 SHA512:
-  metadata.gz: 5419e932910cd6fd9d7a879f46b825eb665a21fc01b4f5638dc55157407375df3fc77d491d5fec4bc48f1e4622df2a55cf057a3f33975dd0fd80abe91c23be55
-  data.tar.gz: 0ce612362e92190a6a4378ea1e9fb91a2163eeacb08a6d4b549e4411259775054e84def3b6025e7e12872a4b03741ed9ae8b320a20f94abb85dcd4572bd3fb5d
+  metadata.gz: 226dc8b0f9d8b0599df1444b0f8c3dd99c8fad7484a7c6cf9d4cc25e136d25cce33c56632f3c0e823216e76f21ab2ff06ff4d629e67134592302b85b95967e00
+  data.tar.gz: c277e9f9ac12001b7b30584e97e67020b9cc6088525249386868a783f0e38a8c88fbaa852ec36246d28a44d7f4cb93c9aaffa7ddfb8c1bca8396f80b569a63ff

data/.yardopts

@@ -14,10 +14,12 @@
 --exclude sequel.rb
 --exclude event.c
 --exclude backend.+\.c
---load ./docs/link_rewriter.rb
+# --load ./docs/link_rewriter.rb
+-r docs/readme.md
 ./lib
 ./ext/polyphony
 -
+docs/readme.md
 docs/overview.md
 docs/tutorial.md
 docs/faq.md

data/README.md

@@ -1,4 +1,4 @@
-<img src="assets/polyphony-logo.png" alt="Polyphony">
+<img src="https://github.com/digital-fabric/polyphony/raw/master/assets/polyphony-logo.png">
 
 # Polyphony: Fine-Grained Concurrency for Ruby
 

data/docs/readme.md

@@ -0,0 +1,102 @@
+# @title README
+
+<img src="https://github.com/digital-fabric/polyphony/raw/master/assets/polyphony-logo.png">
+
+# Polyphony: Fine-Grained Concurrency for Ruby
+
+<a href="http://rubygems.org/gems/polyphony">
+  <img src="https://badge.fury.io/rb/polyphony.svg" alt="Ruby gem">
+</a>
+<a href="https://github.com/digital-fabric/polyphony/actions?query=workflow%3ATests">
+  <img src="https://github.com/digital-fabric/polyphony/workflows/Tests/badge.svg" alt="Tests">
+</a>
+<a href="https://github.com/digital-fabric/polyphony/blob/master/LICENSE">
+  <img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="MIT License">
+</a>
+
+> Polyphony \| pəˈlɪf\(ə\)ni \|
+>
+> 1. _Music_ the style of simultaneously combining a number of parts, each
+>    forming an individual melody and harmonizing with each other.
+>
+> 2. _Programming_ a Ruby gem for concurrent programming focusing on performance
+>    and developer happiness.
+
+## What is Polyphony?
+
+Polyphony is a library for building concurrent applications in Ruby. Polyphony
+harnesses the power of [Ruby fibers](https://ruby-doc.org/core-2.5.1/Fiber.html)
+to provide a cooperative, sequential coroutine-based concurrency model. Under
+the hood, Polyphony uses
+[io_uring](https://unixism.net/loti/what_is_io_uring.html) or
+[libev](https://github.com/enki/libev) to maximize I/O performance.
+
+## Features
+
+* Co-operative scheduling of concurrent tasks using Ruby fibers.
+* High-performance event reactor for handling I/O events and timers.
+* Natural, sequential programming style that makes it easy to reason about
+  concurrent code.
+* Abstractions and constructs for controlling the execution of concurrent code:
+  supervisors, cancel scopes, throttling, resource pools etc.
+* Code can use native networking classes and libraries, growing support for
+  third-party gems such as `pg` and `redis`.
+* Use stdlib classes such as `TCPServer`, `TCPSocket` and
+  `OpenSSL::SSL::SSLSocket`.
+* Competitive performance and scalability characteristics, in terms of both
+  throughput and memory consumption.
+
+## Installing
+
+### System Requirements
+
+In order to use Polyphony you need to have:
+
+- Linux or MacOS (support for Windows will come at a later stage)
+- Ruby (MRI) 3.0 or newer
+
+### Installing the Polyphony Gem
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'polyphony'
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install polyphony
+```
+
+## Usage
+
+- {file:/docs/overview.md Overview}
+- {file:/docs/tutorial.md Tutorial}
+- {file:/docs/faq.md      FAQ}
+
+## Technical Discussion
+
+- {file:/docs/concurrency.md        Concurrency the Easy Way}
+- {file:/docs/fiber-scheduling.md   How Fibers are Scheduled}
+- {file:/docs/exception-handling.md Exception Handling}
+- {file:/docs/extending.md          Extending Polyphony}
+- {file:/docs/design-principles.md  Polyphony's Design}
+
+## Examples
+
+For examples of specific use cases you can consult the [bundled
+examples](https://github.com/digital-fabric/polyphony/tree/master/examples) in
+Polyphony's GitHub repository.
+
+## Contributing to Polyphony
+
+Issues and pull requests will be gladly accepted. Please use the [Polyphony git
+repository](https://github.com/digital-fabric/polyphony) as your primary point
+of departure for contributing.

data/lib/polyphony/version.rb

@@ -2,5 +2,5 @@
 
 module Polyphony
   # @!visibility private
-  VERSION = '0.99.3'
+  VERSION = '0.99.4'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: polyphony
 version: !ruby/object:Gem::Version
-  version: 0.99.3
+  version: 0.99.4
 platform: ruby
 authors:
 - Sharon Rosner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-05-08 00:00:00.000000000 Z
+date: 2023-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake-compiler
@@ -164,6 +164,7 @@ files:
 - docs/link_rewriter.rb
 - docs/main-concepts/index.md
 - docs/overview.md
+- docs/readme.md
 - docs/tutorial.md
 - docs/whats-new.md
 - examples/adapters/pg_client.rb