Update Readme

mackross · mackross · commit 16e73c692ff9 · 2024-12-20T20:47:34.000+13:00
diff --git a/README.md b/README.md
@@ -1,24 +1,26 @@
 # AttributedString
 
-An attributed string implementation for Ruby.
+An attributed string implementation for Ruby. [![Ruby Tests](https://github.com/instruct-rb/attributed-string/actions/workflows/ruby.yml/badge.svg)](https://github.com/instruct-rb/attributed-string/actions/workflows/ruby.yml)
 
-An attributed string contains key-value pairs known as attributes that specify additional information related to ranges of characters within the string. Attributed strings support any key-value pair, but are often used for: 
+An attributed string contains key-value pairs known as attributes that specify additional information related to ranges of characters within the string. Attributed strings support any key-value pair, but are often used for:
 
 - Rendering attributes such as font, color,  and other details.
-- Attributes for inline-attachments such as images, videos, files, etc. 
+- Attributes for inline-attachments such as images, videos, files, etc.
 - Semantic attributes such as link URLs or tool-tip information
-- Language attributes to support automatic gender agreement or verb agreement. 
+- Language attributes to support automatic gender agreement or verb agreement.
 - Accessibility attributes that provide information for assistive technologies
 - Custom attributes you define
 
-You will typically need to create a presenter for an attributed string, as the default shows no attribute information and inspect shows all attributes. 
+You will typically need to create a presenter for an attributed string, as the default shows no attribute information and inspect shows all attributes.
+
+This gem is inspired by Apple's [NSAttributedString](https://developer.apple.com/documentation/foundation/nsattributedstring)
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-  gem 'attributed-string', github: 'instruct-rb/attributed-string', branch: 'main'
+  gem 'attributed-string'
 ```
 
 
@@ -30,16 +32,35 @@ Add this line to your application's Gemfile:
   using AttributedString::Refinements
   hello_world1 = AttributedString.new('Hello, World!',  color: :red, font: 'Helvetica' )
   hello_world2 = 'Hello, World!'.to_attr_s(color: :red, font: 'Helvetica')
-  puts hello_world1 == hello_world2 # true
+  puts hello_world1 == hello_world2
+  # => true
+
+  hello_world1.add_attrs(0..4, color: :blue)
+  hello_world1 += "!!"
+  puts hello_world1.inspect
+  # => { color: blue, font: "Helvetica" }Hello{ color: red}, World!{ -color, -font}!!
+
+  puts hello_world1.attrs_at(0)
+  # { color: blue, font: "Helvetica" }
 ```
 
 ## Attachments
 
 ```ruby
   hello_world = AttributedString.new('Hello, World!')
+
+  # adding an attachment inserts the object character into the string
   hello_world.add_attachment("any ruby object", position: string.length)
   puts hello_world # => "Hello, World! "
   puts hello_world.attachments # => ["any ruby object"]
+
+  # delete the attachment character to remove the attachment
   hello_world[-1..-1] = ''
   puts hello_world.attachments # => []
 ```
+
+## Detailed Usage
+For more detailed usage, see the test suite.
+
+## Used By
+- [Instruct](https://github.com/instruct-rb/instruct) - instruct LLMs to do what you want
