docs: Update documentation links in README and index.md

JuliaPlasma · Nov 14, 2024 · 4e1f1bb · 4e1f1bb
1 parent fd15f5e
commit 4e1f1bb
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -1,7 +1,7 @@
 # ChargedParticles.jl
 
 [![Build Status](https://github.com/Beforerr/ChargedParticles.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/Beforerr/ChargedParticles.jl/actions/workflows/CI.yml?query=branch%3Amain)
-[![Documentation](https://img.shields.io/badge/docs-stable-blue.svg)](https://beforerr.github.io/ChargedParticles.jl/dev/) 
+[![Documentation](https://img.shields.io/badge/docs-dev-blue.svg)](https://beforerr.github.io/ChargedParticles.jl/dev/) 
 
 A Julia package for working with charged particles in plasma physics, inspired by [PlasmaPy](https://github.com/PlasmaPy/PlasmaPy)'s particles subpackage .
 

diff --git a/docs/src/index.md b/docs/src/index.md
@@ -1,6 +1,10 @@
 # ChargedParticles.jl
 
-A Julia package for representing and manipulating charged particles in plasma physics.
+[![Build Status](https://github.com/Beforerr/ChargedParticles.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/Beforerr/ChargedParticles.jl/actions/workflows/CI.yml?query=branch%3Amain)
+[![Documentation](https://img.shields.io/badge/docs-dev-blue.svg)](https://beforerr.github.io/ChargedParticles.jl/dev/) 
+
+
+A Julia package for representing charged particles inspired by [PlasmaPy](https://github.com/PlasmaPy/PlasmaPy)'s particles subpackage.
 
 ## Overview
 
@@ -38,10 +42,18 @@ d = Particle("D+")         # Deuteron
 
 # Access properties
 println("Electron mass: ", mass(e))
+println("Alpha particle charge: ", charge(α))
 println("Iron charge: ", charge(fe3))
 println("Iron-56 mass number: ", mass_number(fe56))
+println("Deuteron mass: ", mass(d))
 ```
 
+## Related Packages
+
+- [PlasmaPy](https://github.com/PlasmaPy/PlasmaPy): A Python package for plasma physics.
+- [Mendeleev.jl](https://github.com/Eben60/Mendeleev.jl): A Julia package for accessing periodic table data.
+- [Corpuscles.jl](https://github.com/Beforerr/Corpuscles.jl): A Julia package for for particle physics.
+
 ## Manual Outline
 
 ```@contents