From 4bed15b058ed68f91af365d90c3f20b7365d7508 Mon Sep 17 00:00:00 2001
From: Jeffrey Phillips Freeman <the@jeffreyfreeman.me>
Date: Tue, 12 Sep 2023 15:16:24 -0400
Subject: [PATCH] Updated the documentation slightly

---
 CHANGELOG.md |  3 ++-
 README.md    | 13 ++++++++-----
 README.rdoc  | 19 -------------------
 3 files changed, 10 insertions(+), 25 deletions(-)
 delete mode 100644 README.rdoc

diff --git a/CHANGELOG.md b/CHANGELOG.md
index a90c9a6..bb32c0c 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -2,10 +2,11 @@
 
 ## 3.0.0
 * Moved all elements of AX.25 out into its own library (https://git.qoto.org/digipex/ax25).
+* No longer backwards compatible with older versions.
 
 ## 2.1.3
 
-* Had to revert some of the changes fromt he last release... KissAbstract now uses include again and kind_of should now work (unit test added to confirm).
+* Had to revert some of the changes from the last release... KissAbstract now uses include again and kind_of should now work (unit test added to confirm).
 
 ## 2.1.2
 
diff --git a/README.md b/README.md
index fbe832a..af770a8 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,5 @@
+[![Gem Version](https://badge.fury.io/rb/kiss-tnc.svg)](https://badge.fury.io/rb/kiss-tnc)
+
 # Kiss
 
 Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/apex`. To experiment with that code, run `bin/console` for an interactive prompt.
@@ -20,17 +22,18 @@ Or install it yourself as:
 
     $ gem install kiss-tnc
 
-## Usage
-
-TODO: Write usage instructions here
-
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
+To run tests do the following:
+
+```bash
+bundle exec rspec
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/Syncleus/kiss-tnc
-
diff --git a/README.rdoc b/README.rdoc
deleted file mode 100644
index 67e0506..0000000
--- a/README.rdoc
+++ /dev/null
@@ -1,19 +0,0 @@
-= apex - DESCRIBE YOUR GEM
-
-Author::  Jeffrey Phillips Freeman (freemo@gmail.com)
-Copyright:: Copyright (c) 2016 Syncleus
-
-
-DESCRIBE YOUR GEM HERE
-
-== Links
-
-* {Source on Github}[https://github.com/Syncleus/kiss-tnc]
-* RDoc[LINK TO RDOC.INFO]
-
-== Install
-
-== Examples
-
-== Contributing
-
-- 
GitLab