Prepare for v1.0.0

Author: ChrisJefferson

PackageInfo.g

@@ -10,8 +10,8 @@ SetPackageInfo( rec(
 
 PackageName := "GraphBacktracking",
 Subtitle := "A simple but slow implementation of graph backtracking",
-Version := "0.5.2",
-Date := "21/12/2021", # dd/mm/yyyy format
+Version := "1.0.0",
+Date := "28/05/2025", # dd/mm/yyyy format
 License := "MPL-2.0",
 
 Persons := [
@@ -77,7 +77,7 @@ PackageDoc := rec(
 Dependencies := rec(
   GAP := ">= 4.13",
   NeededOtherPackages := [
-                           ["BacktrackKit", ">=0.6.1"],
+                           ["BacktrackKit", ">=1.0.0"],
                            ["digraphs", ">=1.1.1"],
                            ["images", ">= 1.3.0"]
                          ],

README.md

@@ -3,18 +3,25 @@
 
 # The GAP package GraphBacktracking
 
-TODO: add a description of your package; perhaps also instructions how how to
-install and use it, resp. where to find out more
+This package provides an implementation of the graph backtracking algorithm, as described in the paper [Computing canonical images in permutation groups with Graph Backtracking](https://arxiv.org/abs/2209.02534) by Christopher Jefferson, Rebecca Waldecker, and Wilf A. Wilson. It extends the **BacktrackKit** package to support graph backtracking.
 
+This algorithm can be used to perform calculations in permutation groups, such as:
+* Group and coset intersection
+* Finding canonical images of combinatorial structures in any permutation group
 
-## Contact
+This package is intended for learning and exploring the graph backtracking algorithm. The performance is **extremely poor**. For a modern, high-performance version of this algorithm, please see the [**vole**](https://github.com/peal/vole) package.
+
+`GraphBacktracking` requires GAP version >= 4.13.0, and recent versions of the following packages (see the `PackageInfo.g` file for specific versions):
+* BacktrackKit
+* datastructures
+* digraphs
+* images
+* primgrp
 
-TODO: add info on how to contact you and/or how to report issues with your
-package
+Additionally, [the QuickCheck package](https://github.com/ChrisJefferson/QuickCheck) is required to run all of the tests.
+
+## Contact
 
-## License
+This package is a work in progress, both in terms of code and documentation.
 
-TODO: Provide information on the license of your package. A license is
-important as it determines who has a right to distribute your package. The
-"default" license to consider is GNU General Public License v2 or later, as
-that is the license of GAP itself.
+If you have any issues or questions about this package, please post an issue at https://github.com/peal/GraphBacktracking/issues