Skip to content

Commit 8df956a

Browse files
committed
implemented project readme
1 parent 286d0e6 commit 8df956a

File tree

1 file changed

+22
-3
lines changed

1 file changed

+22
-3
lines changed

README.md

Lines changed: 22 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,30 @@ Part of a [`ProjectText Suite`](https://github.com/Flagro/ProjectTextSuite). xls
55
## 🌟 **Features**
66
TODO: features
77

8-
## 🚀 **Getting Started**
9-
TODO: installation
8+
## 📥 Installation
9+
10+
To install `xlsx2pandas`, use the following pip command:
11+
```bash
12+
pip3 install git+https://github.com/Flagro/xlsx2pandas.git
13+
```
1014

1115
## 📘 **Usage**
12-
TODO: usage
16+
Run `xlsx2pandas` from the bin folder with these arguments:
17+
18+
1. `path`: Path to the file or directory to process.
19+
2. `--sheet`: (Optional) Comma-separated list of excel workbooks's sheets.
20+
21+
### 🖥️ Example Command
22+
```bash
23+
xlsx2pandas 'path/to/file' --sheet Sheet1,Sheet2
24+
```
1325

1426
## 🤝 **Collaboration & Issues**
1527
Open for collaboration; check the [issues page](https://github.com/Flagro/xlsx2pandas/issues) for discussions.
28+
29+
Here's how you can contribute:
30+
1. Fork the Project.
31+
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`).
32+
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`).
33+
4. Push to the Branch (`git push origin feature/AmazingFeature`).
34+
5. Open a Pull Request.

0 commit comments

Comments
 (0)