Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #34

Merged
merged 5 commits into from
Jan 10, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 2 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,20 @@
[![CI](https://github.com/DiamondLightSource/i10-bluesky/actions/workflows/ci.yml/badge.svg)](https://github.com/DiamondLightSource/i10-bluesky/actions/workflows/ci.yml)
[![Coverage](https://codecov.io/gh/DiamondLightSource/branch/main/graph/badge.svg)](https://codecov.io/gh/DiamondLightSource/i10-bluesky)
[![Coverage](https://codecov.io/gh/DiamondLightSource/i10-bluesky/branch/main/graph/badge.svg)](https://codecov.io/gh/DiamondLightSource/i10-bluesky)
[![PyPI](https://img.shields.io/pypi/v/i10_bluesky.svg)](https://pypi.org/project/i10_bluesky)
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

# i10_bluesky

i10 bluesky project

This is where you should write a short paragraph that describes what your module does,
how it does it, and why people should use it.
This module contains bluesky plans for beamline i10.

Source | <https://github.com/DiamondLightSource/i10-bluesky>
:---: | :---:
PyPI | `pip install i10_bluesky`
Documentation | <https://DiamondLightSource.github.io/i10-bluesky>
Releases | <https://github.com/DiamondLightSource/i10-bluesky/releases>

This is where you should put some images or code snippets that illustrate
some relevant examples. If it is a library then you might put some
introductory code here:

```python
from i10_bluesky import __version__

print(f"Hello i10_bluesky {__version__}")
```

Or if it is a commandline tool then you might put some example commands here:

```
python -m i10_bluesky --version
```

<!-- README only content. Anything below this line won't be included in index.md -->

Expand Down
Loading