Skip to content

Commit

Permalink
update readme order
Browse files Browse the repository at this point in the history
  • Loading branch information
Borda committed Jul 19, 2024
1 parent 40360ed commit 6ddb90d
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 33 deletions.
8 changes: 4 additions & 4 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,21 +6,21 @@ updates:
directory: "/requirements"
schedule:
interval: "weekly"
labels: ["ci/cd"]
labels: ["requirements", "enhancement"]
pull-request-branch-name:
separator: "-"
open-pull-requests-limit: 5
reviewers:
- "Lightning-AI/core-lightning"
- "borda"

# Enable version updates for GitHub Actions
- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: "weekly"
labels: ["ci/cd"]
labels: ["ci/cd", "enhancement"]
pull-request-branch-name:
separator: "-"
open-pull-requests-limit: 5
reviewers:
- "Lightning-AI/core-lightning"
- "borda"
58 changes: 29 additions & 29 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ __This repository covers the following use-cases:__

1. _Reusable GitHub workflows_
2. _Shared GitHub actions_
3. _CLI `python -m lightning_utilities.cli --help`_
4. _General Python utilities in `lightning_utilities.core`_
3. _General Python utilities in `lightning_utilities.core`_
4. _CLI `python -m lightning_utilities.cli --help`_

## 1. Reusable workflows

Expand Down Expand Up @@ -61,9 +61,7 @@ jobs:
requires: oldest # or latest
```

## 3. CLI `lightning_utilities.cli`

The package provides common CLI commands.
## 3. General Python utilities `lightning_utilities.core`

<details>
<summary>Installation</summary>
Expand All @@ -75,6 +73,32 @@ pip install https://github.com/Lightning-AI/utilities/archive/refs/heads/main.zi

From pypi:

```bash
pip install lightning_utilities
```

</details>

__Usage:__

Example for optional imports:

```python
from lightning_utilities.core.imports import module_available

if module_available("some_package.something"):
from some_package import something
```

## 4. CLI `lightning_utilities.cli`

The package provides common CLI commands.

<details>
<summary>Installation</summary>

From pypi:

```bash
pip install lightning_utilities[cli]
```
Expand Down Expand Up @@ -107,27 +131,3 @@ pytest-timeout
```

</details>

## 4. General Python utilities `lightning_utilities.core`

<details>
<summary>Installation</summary>

From pypi:

```bash
pip install lightning_utilities
```

</details>

__Usage:__

Example for optional imports:

```python
from lightning_utilities.core.imports import module_available

if module_available("some_package.something"):
from some_package import something
```

0 comments on commit 6ddb90d

Please sign in to comment.