Merge pull request #6 from cgay/dev

Fix doc dependency and a few grammar issues

documentation/source/conf.py

@@ -9,7 +9,7 @@
 project = 'base64'
 copyright = '2024, Carl Gay'
 author = 'Carl Gay'
-release = '0.1.1'
+release = '0.2.0'
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

documentation/source/usage.rst

@@ -10,14 +10,14 @@ See also :doc:`reference`
 Quickstart
 ----------
 
-Add ``use base64;`` to both your library file.
+Add ``use base64;`` to your library and module definitions.
 
-This library exports two functions
+This library exports two functions:
 
--  :func:`base64-encode` and
+-  :func:`base64-encode`
 -  :func:`base64-decode`
 
-that accept a :drm:`<byte-string>` and returns a :drm:`<byte-string>`.
+Both functions accept a :drm:`<byte-string>` and return a :drm:`<byte-string>`.
 
 Types of encoding
 -----------------
@@ -28,8 +28,8 @@ The functions have two types of encoding/decoding:
 
 -  ``#"http"``
 
-The main difference between them are the padding characters used. You
-can choose the type with the key parameter ``encoding:`` (see example
+The main difference between them is the padding characters used. You
+can choose the type with the ``encoding:`` parameter (see example
 below).
 
 Example
@@ -62,7 +62,7 @@ Here is an example of usage of the standard encoding/decoding:
 HTTP encoding/decoding
 ~~~~~~~~~~~~~~~~~~~~~~
 
-To show the http encoding/decoding we will use a text that forces the
+To show the HTTP encoding/decoding we will use a text that forces the
 padding (base64 encoding uses padding to ensure that the length of the
 encoded string is a multiple of 4 bytes).
 

dylan-package.json

@@ -1,11 +1,14 @@
 {
+    "name": "base64",
+    "version": "0.2.0",
+    "description": "Base-64 encoding/decoding",
     "category": "encoding",
     "contact": "[email protected]",
     "dependencies": [  ],
-    "dev-dependencies": [ "testworks" ],
-    "description": "Base64 encoding",
-    "name": "base64",
-    "version": "0.1.1",
+    "dev-dependencies": [
+        "sphinx-extensions",
+        "testworks"
+    ],
     "url": "https://github.com/dylan-lang/base64",
     "keywords": [ "base64", "binary" ],
     "license": "Unlicensed",