Skip to content

Commit

Permalink
doc: Update features
Browse files Browse the repository at this point in the history
  • Loading branch information
Beforerr committed Nov 16, 2024
1 parent 3daffab commit da6e425
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 9 deletions.
9 changes: 4 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,10 @@ A Julia package for working with charged particles in plasma physics, inspired b

## Features

- Support for common particles (electrons, protons)
- Custom ion creation with arbitrary charge states
- Basic particle properties (mass, charge, atomic number)
- Type checking functions (is_electron, is_proton, is_ion)
- Pretty printing of particle representations
- Support for elementary particles, ions, and isotopes
- Flexible string-based particle construction with common particle aliases
- Physical properties (mass, charge, atomic number, charge number, etc.)
- Integration with [Mendeleev.jl](https://github.com/Eben60/Mendeleev.jl) for chemical element data

## Installation

Expand Down
7 changes: 3 additions & 4 deletions docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,9 @@ ChargedParticles.jl provides a flexible type system for working with various par
## Features

- Support for elementary particles, ions, and isotopes
- Flexible string-based particle construction
- Physical properties (mass, charge, etc.)
- Common particle aliases
- Unit support via Unitful.jl
- Flexible string-based particle construction with common particle aliases
- Physical properties (mass, charge, atomic number, charge number, etc.)
- Integration with [Mendeleev.jl](https://github.com/Eben60/Mendeleev.jl) for chemical element data

## Installation

Expand Down

0 comments on commit da6e425

Please sign in to comment.