Skip to content

Commit 5e24fd5

Browse files
committed
docs: document fork origin and remove references to original repo
1 parent 37a5fb2 commit 5e24fd5

1 file changed

Lines changed: 8 additions & 6 deletions

File tree

README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,26 @@
11
# Boscli
22

3-
[![CI](https://github.com/aleasoluciones/boscli/actions/workflows/ci.yml/badge.svg)](https://github.com/aleasoluciones/boscli/actions/workflows/ci.yml)
4-
[![Coverage Status](https://coveralls.io/repos/github/aleasoluciones/boscli/badge.svg)](https://coveralls.io/github/aleasoluciones/boscli)
53
![Python versions supported](https://img.shields.io/badge/supports%20python-3.9%20|%203.10%20|%203.11%20|%203.12-blue.svg)
6-
[![License](https://img.shields.io/github/license/aleasoluciones/boscli)](https://github.com/aleasoluciones/boscli/blob/master/LICENSE)
4+
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
75

86
**Boscli** is the base infrastructure to create *ad hoc* shells or command line interfaces using Python.
97

108
It includes an engine for command completion, types verification, command help and other useful features. It can be used with readline to provide advanced line editing, history and autocompletion.
119

10+
## About this Fork
11+
12+
This project is a fork of [aleasoluciones/boscli](https://github.com/aleasoluciones/boscli). While we acknowledge and appreciate the original work, this fork will follow its own direction with different goals and development priorities.
13+
1214
## Examples
1315

1416
See [examples](examples) dir for a minimal ad hoc shell using readline.
1517

1618
## Installation
1719

18-
You can install the latest sources from GitHub in your project.
20+
You can install the package in development mode:
1921

2022
```bash
21-
python -m pip install -e git+git://github.com/aleasoluciones/boscli.git#egg=boscli
23+
python -m pip install -e .
2224
```
2325

2426
## Specs
@@ -32,4 +34,4 @@ mamba
3234

3335
## Contribute
3436

35-
If you'd like to contribute, fork [repository](http://github.com/aleasoluciones/boscli), and send a pull request.
37+
If you'd like to contribute, fork this repository and send a pull request.

0 commit comments

Comments
 (0)