Add docs badge and links

Author: RUzcategui

.github/workflows/documentation.yml

@@ -4,21 +4,36 @@ on:
   push:
     branches:
       - main
-    tags: '*'
+    tags:
+      - '*'
   pull_request:
 
 jobs:
-  build:
+  docs:
     runs-on: ubuntu-latest
+
     steps:
-      - uses: actions/checkout@v2
-      - uses: julia-actions/setup-julia@latest
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Julia
+        uses: julia-actions/setup-julia@v2
         with:
-          version: '1'
+          version: '1.10'
+
+      - name: Cache Julia artifacts
+        uses: julia-actions/cache@v2
+
       - name: Install dependencies
-        run: julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()'
-      - name: Build and deploy
+        run: |
+          julia --project=docs -e '
+            using Pkg
+            Pkg.develop(PackageSpec(path=pwd()))
+            Pkg.instantiate()
+          '
+
+      - name: Build and deploy documentation
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}
-        run: julia --project=docs/ docs/make.jl
+        run: |
+          julia --project=docs docs/make.jl

README.md

@@ -1,8 +1,17 @@
 # Stereonet.jl
 
+# Stereonet.jl
+
+[![Docs](https://img.shields.io/badge/docs-stable-blue.svg)](https://ruzcategui.github.io/Stereonet.jl/)
+
+A Julia package for plotting orientation data on stereonets using Makie.
+
+
 Stereonet.jl is a plotting package for visualizing three-dimensional
 orientation data on two-dimensional nets using Makie.
 
 It provides methods to visualize planar, linear features, and
 small circles on equal-angle (Wulff) and equal-area (Schmidt) nets, 
-with support for arbitrary viewing directions.
+with support for arbitrary viewing directions.
+
+📘 **Documentation**: https://ruzcategui.github.io/Stereonet.jl/

docs/src/guide_and_examples.md

@@ -4,17 +4,6 @@ CurrentModule = Stereonet
 
 ## User Guide
 
-### Installation
-
-Stereonet is not yet registered in the General Julia registry.
-You can install it directly from GitHub:
-
-```julia
-using Pkg
-
-] add https://github.com/RUzcategui/Stereonet.jl
-```
-
 ### Creating a Stereonet
 
 Create a stereonet with default attributes:

docs/src/index.md

@@ -10,6 +10,20 @@ It provides methods to visualize planar, linear features, and
 small circles on equal-angle (Wulff) and equal-area (Schmidt) nets, 
 with support for arbitrary viewing directions.
 
-### Acknowledgements
+## Installation
+
+
+You can install Stereonet by typing the following in the Julia REPL:
+```julia
+] add Stereonet 
+```
+
+followed by 
+```julia
+using Stereonet
+```
+to load the package.
+
+## Acknowledgements
 
 This package makes extensive use of Makie.jl, whose powerful and flexible visualization framework made this package possible. I would like to thank the developers and contributors of Makie for their outstanding work and for providing such a rich ecosystem for scientific visualization in Julia.