Skip to content

Commit ba499c7

Browse files
committed
feat: enhance installation and configuration instructions in README
1 parent 11ba953 commit ba499c7

File tree

1 file changed

+43
-1
lines changed

1 file changed

+43
-1
lines changed

README.md

Lines changed: 43 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,51 @@ Before using Invoice2Erpnext, ensure:
1313
1. You've installed the Invoice2Erpnext app in your ERPNext instance
1414
2. Your administrator has configured the "Invoice2Erpnext Settings" with:
1515
- API credentials (api_key and api_secret)
16-
- BASE_URL for the document extraction service
1716
- Default VAT account
1817

18+
### Installation
19+
20+
To install Invoice2Erpnext:
21+
22+
1. Navigate to your bench directory:
23+
```
24+
cd /path/to/frappe-bench
25+
```
26+
27+
2. Get the app:
28+
```
29+
bench get-app invoice2erpnext https://github.com/organization/invoice2erpnext
30+
```
31+
32+
3. Install the app on your site:
33+
```
34+
bench --site your-site.com install-app invoice2erpnext
35+
```
36+
37+
4. Run migrations to update the database:
38+
```
39+
bench --site your-site.com migrate
40+
```
41+
42+
5. Restart your server:
43+
```
44+
bench restart
45+
```
46+
47+
### Configuration
48+
49+
To configure Invoice2Erpnext:
50+
51+
1. Log in to your ERPNext site with Administrator privileges
52+
2. Navigate to **Invoice2Erpnext Settings** in the menu
53+
3. Configure the following required settings:
54+
- **API Credentials**: Enter your api_key and api_secret obtained from the invoice processing service
55+
- **Default VAT Account**: Select the account to be used for tax calculations
56+
57+
4. Save the settings
58+
59+
These configurations are essential for the app to function properly. Without valid API credentials, the system won't be able to process invoices.
60+
1961
## How to Use
2062

2163
### Processing Invoices

0 commit comments

Comments
 (0)