From e8cfadc0abfac5cc8321981092d03664d9d4ed15 Mon Sep 17 00:00:00 2001 From: Beforerr Date: Fri, 6 Dec 2024 10:06:27 -0800 Subject: [PATCH] docs: update repository links and improve README content --- README.md | 11 +++-------- docs/make.jl | 2 +- docs/src/index.md | 6 +++--- 3 files changed, 7 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 2f20560..e6d3163 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,9 @@ # 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-dev-blue.svg)](https://beforerr.github.io/ChargedParticles.jl/dev/) +[![Build Status](https://github.com/JuliaPlasma/ChargedParticles.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/JuliaPlasma/ChargedParticles.jl/actions/workflows/CI.yml?query=branch%3Amain) +[![Documentation](https://img.shields.io/badge/docs-dev-blue.svg)](https://JuliaPlasma.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 . +A Julia package for representing charged particles inspired by [PlasmaPy](https://github.com/PlasmaPy/PlasmaPy)'s particles subpackage. ## Features @@ -19,11 +19,6 @@ using Pkg Pkg.add("ChargedParticles") ``` -## Dependencies - -- Unitful.jl: For handling physical units -- [Mendeleev.jl](https://github.com/Eben60/Mendeleev.jl): For periodic table data - ## Contributing Contributions are welcome! Please feel free to submit a Pull Request. diff --git a/docs/make.jl b/docs/make.jl index 747c83f..641895e 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -20,5 +20,5 @@ makedocs( ) deploydocs( - repo="github.com/Beforerr/ChargedParticles.jl", + repo="github.com/JuliaPlasma/ChargedParticles.jl", ) diff --git a/docs/src/index.md b/docs/src/index.md index a81910a..f673364 100644 --- a/docs/src/index.md +++ b/docs/src/index.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-dev-blue.svg)](https://beforerr.github.io/ChargedParticles.jl/dev/) +[![Build Status](https://github.com/JuliaPlasma/ChargedParticles.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/JuliaPlasma/ChargedParticles.jl/actions/workflows/CI.yml?query=branch%3Amain) +[![Documentation](https://img.shields.io/badge/docs-dev-blue.svg)](https://JuliaPlasma.github.io/ChargedParticles.jl/dev/) A Julia package for representing charged particles inspired by [PlasmaPy](https://github.com/PlasmaPy/PlasmaPy)'s particles subpackage. @@ -51,7 +51,7 @@ println("Deuteron mass: ", mass(d)) - [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. +- [Corpuscles.jl](https://github.com/JuliaPhysics/Corpuscles.jl): A Julia package for for particle physics. ## Manual Outline