Changed description and version for new release

harrydowning · May 17, 2023 · 18417a1 · 18417a1
1 parent 8d8f66a
commit 18417a1
Show file tree

Hide file tree

Showing 6 changed files with 19 additions and 11 deletions.
diff --git a/README.md b/README.md
@@ -1,5 +1,12 @@
-# Serialized Language (serl)
-Serl is a command line tool used to manage and execute programming languages serialized with YAML.
+# Serl - A tool for creating and using languages
+<a href="https://pypi.org/project/serl/">
+  <img src="https://img.shields.io/pypi/v/serl"/>
+</a>
+<a href="https://github.com/harrydowning/serl/blob/master/LICENSE">
+  <img src="https://img.shields.io/github/license/harrydowning/serl"/>
+</a>
+
+Serl (serialized languages) is a format and corresponding command line tool for creating and using textual domain specific or markup languages with arbitrary syntax. This is achieved through the concept of language configurations, which are YAML files for specifying language syntax and functionality, used by the tool to execute language programs. These configurations can then be linked, allowing languages to be used like any other command line tool.
 
 Documentation can be found on [Read The Docs](https://serl.readthedocs.io/en/latest/index.html).
 

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -9,7 +9,7 @@
 project = 'Serl'
 copyright = '2023, Harry Downing'
 author = 'Harry Downing'
-release = '0.2.2-beta'
+release = '0.3.0-beta'
 
 master_doc = 'index'
 

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -1,12 +1,9 @@
 Overview
 ========
 
-Serl is a command line tool used to manage and execute programming languages serialized with YAML.
-The format of these language is specified in the :ref:`lang-config` section.
-
-..
-  .. Note::
-    At the moment the tool is in an early stage of its development and so its interface may change.
+Serl (serialized languages) is a format and corresponding command line tool for creating and using textual domain specific or markup languages with arbitrary syntax.
+This is achieved through the concept of :ref:`language configurations <lang-config>`, which are YAML files for specifying language syntax and functionality, used by the tool to execute language programs.
+These configurations can then be :ref:`linked <link>`, allowing languages to be used like any other command line tool.
 
 .. toctree::
   :caption: Home

diff --git a/docs/source/user_guide/cli.rst b/docs/source/user_guide/cli.rst
@@ -1,3 +1,5 @@
+.. _cli:
+
 Command Line Interface
 ======================
 
@@ -28,6 +30,8 @@ The following usage pattern shows the tool's main interface.
       -v, --verbose  Provide more output.
 
 
+.. _link:
+
 link
 ----
 :Usage:

diff --git a/setup.cfg b/setup.cfg
@@ -3,7 +3,7 @@ name = serl
 version = attr: serl.constants.VERSION
 author = Harry Downing
 author_email = harry.downing17@gmail.com
-description = Serialized Language (serl)
+description = Serl - A tool for creating and using languages
 long_description = file: README.md, LICENSE
 long_description_content_type = text/markdown
 license = MIT

diff --git a/src/serl/constants.py b/src/serl/constants.py
@@ -1,5 +1,5 @@
 NAME = __package__
-VERSION = '0.2.2-beta'
+VERSION = '0.3.0-beta'
 
 SYSTEM_CONFIG_DIR = f'.{NAME}'
 SYSTEM_CONFIG_ENV_DIR = 'environments'