Prepare for registry

.github/workflows/documentation.yml

@@ -18,7 +18,7 @@ jobs:
       - uses: actions/checkout@v4
       - uses: julia-actions/setup-julia@v2
         with:
-          version: '1.6'
+          version: '1.10'
       - uses: julia-actions/cache@v1
       - name: Install dependencies
         run: julia --project=docs/ -e 'using Pkg; Pkg.add("Documenter"); Pkg.instantiate()'

Project.toml

@@ -1,14 +1,16 @@
 name = "BcdiTrad"
 uuid = "b788224a-5de6-46e5-9aeb-ad1a5171efd9"
 authors = ["Jason Meziere"]
-version = "1.0.0-DEV"
+version = "0.0.1"
 
 [deps]
 BcdiCore = "72eb6a3e-ca63-4742-b260-85b05ca6d9e4"
 CUDA = "052768ef-5323-5732-b1bb-66c8b64840ba"
 
 [compat]
-julia = "1.6.7"
+julia = "1.10"
+BcdiCore = "0.0.1"
+CUDA = "5.4.3"
 
 [extras]
 Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"

README.md

@@ -1,7 +1,20 @@
 # BcdiTrad
 
-[![Build Status](https://github.com/jmeziere/BcdiTrad.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/jmeziere/BcdiTrad.jl/actions/workflows/CI.yml?query=branch%3Amain)
-=======
-# BcdiTrad
-
+<-- [![Build Status](https://github.com/jmeziere/BcdiTrad.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/jmeziere/BcdiTrad.jl/actions/workflows/CI.yml?query=branch%3Amain) -->
 [![](https://img.shields.io/badge/docs-dev-blue.svg)](https://byu-cig.github.io/BcdiTrad.jl/dev)
+
+## About
+
+Bragg Coherent Diffraction Imaging (BCDI) Trad (Traditional) implements projection-based phase retrieval algorithms. Some of the core functionality of this project is implemented in BcdiCore.jl. Additionally, this package is part of a collection of BCDI packages consisting of BcdiAtomic.jl (an atomic scale BCDI solver), BcdiMeso.jl (a mesoscale BCDI Solver), and BcdiMulti.jl (a multiscale BCDI solver).
+
+While this package is marked as BCDI specific, the methods are more general and can be used in many phase retrieval problems. In the future, this package may be incorporated into a more general phase retrieval core package.
+
+Currently, this entire package must be run with access to GPUs. This may change in the future (especially if Issues requesting it are opened), but for our research group, using GPUs is a necessity.
+
+## Installation
+
+Currently, BcdiTrad.jl is registered in the Julia general registry and can be installed by running in the REPL package manager (```]```):
+
+```
+add BcdiTrad
+```

docs/src/index.md

@@ -10,9 +10,8 @@ Currently, this entire package must be run with access to GPUs. This may change
 
 ## Installation
 
-Currently, BcdiTrad.jl is not registered in the Julia general registry. BcdiTrad.jl can be installed by running in the REPL package manager (```]```):
+Currently, BcdiTrad.jl is registered in the Julia general registry and can be installed by running in the REPL package manager (```]```):
 
 ```
-add https://github.com/byu-cig/BcdiCore.jl.git
-add https://github.com/byu-cig/BcdiTrad.jl.git
+add BcdiTrad
 ```