Bump minor version.

Author: ioquatix

context/example-server.md

@@ -0,0 +1,3 @@
+# Example Server
+
+This guide demonstrates how to use {ruby Localhost::Authority} to implement a simple HTTPS client & server.

context/getting-started.md

@@ -0,0 +1,85 @@
+# Getting Started
+
+This guide explains how to use `localhost` for provisioning local TLS certificates for development.
+
+## Installation
+
+Add the gem to your project:
+
+~~~ bash
+$ bundle add localhost
+~~~
+
+Then, generate an issuer certificate and install it:
+
+~~~ bash
+$ bundle exec bake localhost:install
+~~~
+
+You may be prompted for a password to install the certificate. This is the password for your local keychain.
+
+### Purging your certificates
+
+If you have an existing installation which does not use the issuer certificate, you can remove the existing certificates and start over:
+
+~~~ bash
+$ bundle exec bake localhost:purge
+~~~
+
+Note this will remove all certificates in the `$XDG_STATE_HOME/localhost.rb/` directory, but it won't remove the issuer certificate that was installed in your keychain.
+
+## Core Concepts
+
+`localhost` has two core concepts:
+
+- A {ruby Localhost::Issuer} instance which represents a certificate authority (CA) that can be used to sign certificates for localhost.
+- A {ruby Localhost::Authority} instance which represents a public and private key pair that can be used for both clients and servers.
+
+### Files
+
+The certificate and private key are stored in `$XDG_STATE_HOME/localhost.rb/` (typically `~/.local/state/localhost.rb/`). You can delete them and they will be regenerated. If you added the certificate to your computer's certificate store/keychain, you'll you'd need to update it.
+
+## Usage
+
+In general, you won't need to do anything at all. The application server you are using will automatically provision a self-signed certificate for localhost. That being said, if you want to implement your own self-signed secure server, the following example demonstrates how to use the {ruby Localhost::Authority}:
+
+``` ruby
+require "socket"
+require "thread"
+
+require "localhost/authority"
+
+# Get the self-signed authority for localhost:
+authority = Localhost::Authority.fetch
+
+ready = Thread::Queue.new
+
+# Start a server thread:
+server_thread = Thread.new do
+	server = OpenSSL::SSL::SSLServer.new(TCPServer.new("localhost", 4050), authority.server_context)
+	
+	server.listen
+	
+	ready << true
+	
+	peer = server.accept
+	
+	peer.puts "Hello World!"
+	peer.flush
+	
+	peer.close
+end
+
+ready.pop
+
+client = OpenSSL::SSL::SSLSocket.new(TCPSocket.new("localhost", 4050), authority.client_context)
+
+# Initialize SSL connection:
+client.connect
+
+# Read the encrypted message:
+puts client.read(12)
+
+client.close
+server_thread.join
+```

context/index.yaml

@@ -0,0 +1,17 @@
+# Automatically generated context index for Utopia::Project guides.
+# Do not edit then files in this directory directly, instead edit the guides and then run `bake utopia:project:agent:context:update`.
+---
+description: Manage a local certificate authority for self-signed localhost development
+  servers.
+metadata:
+  documentation_uri: https://socketry.github.io/localhost/
+  source_code_uri: https://github.com/socketry/localhost.git
+files:
+- path: getting-started.md
+  title: Getting Started
+  description: This guide explains how to use `localhost` for provisioning local TLS
+    certificates for development.
+- path: example-server.md
+  title: Example Server
+  description: This guide demonstrates how to use <code class="language-ruby">Localhost::Authority</code>
+    to implement a simple HTTPS client & server.

lib/localhost/version.rb

@@ -4,5 +4,5 @@
 # Copyright, 2018-2026, by Samuel Williams.
 
 module Localhost
-	VERSION = "1.7.0"
+	VERSION = "1.8.0"
 end

readme.md

@@ -22,6 +22,10 @@ Please see the [project documentation](https://socketry.github.io/localhost/) fo
 
 Please see the [project releases](https://socketry.github.io/localhost/releases/index) for all releases.
 
+### v1.8.0
+
+  - Add `bake` as direct dependency.
+
 ### v1.6.0
 
   - Add support for `update-ca-trust` on Linux sytems.

releases.md

@@ -1,6 +1,6 @@
 # Releases
 
-## Unreleased
+## v1.8.0
 
   - Add `bake` as direct dependency.