Skip to content

Commit 70004d3

Browse files
Update README.md
Text Formatting.
1 parent 5850ecd commit 70004d3

File tree

1 file changed

+47
-66
lines changed

1 file changed

+47
-66
lines changed

docs/README.md

+47-66
Original file line numberDiff line numberDiff line change
@@ -9,52 +9,31 @@ Reserved.*
99

1010
------------------------------------------------------------------------
1111

12-
**Table of Contents**
13-
14-
- 1\. Introduction
15-
16-
- 2\. Installation
17-
18-
- 3\. Main Functions of the Script
19-
20-
- 3.1 Getting License Information (\--license-info)
21-
22-
- 3.2 Getting Service Usage Information (\--service-usage)
23-
24-
- 3.3 Uploading Code and Creating a License (\--upload)
25-
26-
- 3.4 Updating Previously Uploaded Code (\--update)
27-
28-
- 4\. Detailed Description of Each Function
29-
30-
- 4.1 Getting License Information (\--license-info)
31-
32-
- 4.2 Getting Service Usage Information (\--service-usage)
33-
34-
- 4.3 Uploading Code and Creating a License (\--upload)
35-
36-
- 4.4 Updating Previously Uploaded Code (\--update)
37-
38-
- 5\. Additional Features
39-
40-
- 5.1 Extending the License Expiration Date (\--extend)
41-
42-
- 5.2 Setting the Maximum Number of Hardware IDs (\--set_hwids)
43-
44-
- 5.3 Deleting Licenses and Code
45-
(\--license-removal, \--code-removal)
46-
47-
- 6\. Working with Logs
48-
49-
- 6.1 Description of the license_cloud_info.log File
50-
51-
- 6.2 How to Interpret Records in the Log
52-
53-
- Appendix A: Installation of Required Packages
54-
55-
- Appendix B: Contact Information
56-
57-
**1. Introduction**
12+
## Table of Contents
13+
14+
- [1. Introduction](#1-introduction)
15+
- [2. Installation](#2-installation)
16+
- [3. Main Functions of the Script](#3-main-functions-of-the-script)
17+
- [3.1 Getting License Information (--license-info)](#31-getting-license-information---license-info)
18+
- [3.2 Getting Service Usage Information (--service-usage)](#32-getting-service-usage-information---service-usage)
19+
- [3.3 Uploading Code and Creating a License (--upload)](#33-uploading-code-and-creating-a-license---upload)
20+
- [3.4 Updating Previously Uploaded Code (--update)](#34-updating-previously-uploaded-code---update)
21+
- [4. Detailed Description of Each Function](#4-detailed-description-of-each-function)
22+
- [4.1 Getting License Information (--license-info)](#41-getting-license-information---license-info)
23+
- [4.2 Getting Service Usage Information (--service-usage)](#42-getting-service-usage-information---service-usage)
24+
- [4.3 Uploading Code and Creating a License (--upload)](#43-uploading-code-and-creating-a-license---upload)
25+
- [4.4 Updating Previously Uploaded Code (--update)](#44-updating-previously-uploaded-code---update)
26+
- [5. Additional Features](#5-additional-features)
27+
- [5.1 Extending the License Expiration Date (--extend)](#51-extending-the-license-expiration-date---extend)
28+
- [5.2 Setting the Maximum Number of Hardware IDs (--set_hwids)](#52-setting-the-maximum-number-of-hardware-ids---set_hwids)
29+
- [5.3 Deleting Licenses and Code](#53-deleting-licenses-and-code)
30+
- [6. Working with Logs](#6-working-with-logs)
31+
- [6.1 Description of the license_cloud_info.log File](#61-description-of-the-license_cloud_infolog-file)
32+
- [6.2 How to Interpret Records in the Log](#62-how-to-interpret-records-in-the-log)
33+
- [Appendix A: Installation of Required Packages](#appendix-a-installation-of-required-packages)
34+
- [Appendix B: Contact Information](#appendix-b-contact-information)
35+
36+
# 1. Introduction
5837

5938
The **Secure Python Code Manager Script** is a command-line tool
6039
designed to manage your code licenses with the Alpha Beta Network cloud
@@ -79,7 +58,7 @@ property and want to distribute their Python scripts securely. By using
7958
cloud-based licensing, you ensure that only authorized users can access
8059
and execute your code.
8160

82-
**2. Installation**
61+
# 2. Installation
8362

8463
Before using the Secure Python Code Manager Script, ensure that you
8564
have **Python 3** installed on your system.
@@ -107,24 +86,24 @@ installing the packages.
10786

10887
Download the secure_python_code_manager.py script to your local machine.
10988

110-
**3. Main Functions of the Script**
89+
# 3. Main Functions of the Script
11190

11291
The Secure Python Code Manager Script provides the following main
11392
functionalities:
11493

115-
- **3.1 Getting License Information (\--license-info)**
94+
## 3.1 Getting License Information (\--license-info)
11695

117-
- **3.2 Getting Service Usage Information (\--service-usage)**
96+
## 3.2 Getting Service Usage Information (\--service-usage)
11897

119-
- **3.3 Uploading Code and Creating a License (\--upload)**
98+
## 3.3 Uploading Code and Creating a License (\--upload)
12099

121-
- **3.4 Updating Previously Uploaded Code (\--update)**
100+
## 3.4 Updating Previously Uploaded Code (\--update)
122101

123102
------------------------------------------------------------------------
124103

125-
**4. Detailed Description of Each Function**
104+
# 4. Detailed Description of Each Function
126105

127-
**4.1 Getting License Information (\--license-info)**
106+
## 4.1 Getting License Information (\--license-info)
128107

129108
This function retrieves detailed information about your licenses,
130109
including their status, usage data, and associated limits.
@@ -281,7 +260,7 @@ reflect the changes made.
281260

282261
------------------------------------------------------------------------
283262

284-
**4.2 Getting Service Usage Information (\--service-usage)**
263+
## 4.2 Getting Service Usage Information (\--service-usage)
285264

286265
This function retrieves information about your service usage, including
287266
uploaded scripts and associated licenses.
@@ -397,7 +376,7 @@ If removal options are used, the script will confirm the deletions.
397376

398377
------------------------------------------------------------------------
399378

400-
**4.3 Uploading Code and Creating a License (\--upload)**
379+
## 4.3 Uploading Code and Creating a License (\--upload)
401380

402381
This function allows you to upload your Python script to the cloud and
403382
create a new license for it.
@@ -455,7 +434,7 @@ new filename including the expiration date and product serial number.
455434
- **Error:** *Failed to receive license information from the server.\
456435
***Solution:** Check server connectivity and try again later.
457436

458-
**4.4 Updating Previously Uploaded Code (\--update)**
437+
## 4.4 Updating Previously Uploaded Code (\--update)
459438

460439
This function updates a previously uploaded script associated with a
461440
specific license.
@@ -509,9 +488,9 @@ Update successful.
509488

510489
------------------------------------------------------------------------
511490

512-
**5. Additional Features**
491+
# 5. Additional Features
513492

514-
**5.1 Extending the License Expiration Date (\--extend)**
493+
## 5.1 Extending the License Expiration Date (\--extend)
515494

516495
Use the \--extend option with \--license-info to extend the expiration
517496
date of specified licenses by 24 hours.
@@ -536,7 +515,7 @@ python secure_python_code_manager.py --license-info -l 1234567890 --extend
536515

537516
------------------------------------------------------------------------
538517

539-
**5.2 Setting the Maximum Number of Hardware IDs (\--set_hwids)**
518+
## 5.2 Setting the Maximum Number of Hardware IDs (\--set_hwids)
540519

541520
Use the \--set_hwids option with \--license-info to set the maximum
542521
number of hardware IDs for specified licenses.
@@ -561,7 +540,9 @@ python secure_python_code_manager.py --license-info -l 1234567890 --set_hwids 5
561540

562541
------------------------------------------------------------------------
563542

564-
**5.3 Deleting Licenses and Code (\--license-removal, \--code-removal)**
543+
## 5.3 Deleting Licenses and Code
544+
545+
Deleting Licenses and Code (\--license-removal, \--code-removal)
565546

566547
Use these options with \--service-usage to remove licenses or code
567548
entries.
@@ -600,13 +581,13 @@ python secure_python_code_manager.py --service-usage --code-removal 1122334455,5
600581

601582
------------------------------------------------------------------------
602583

603-
**6. Working with Logs**
584+
# 6. Working with Logs
604585

605586
The script saves operation details to a log file
606587
named license_cloud_info.log, which can be used for auditing and
607588
troubleshooting.
608589

609-
**6.1 Description of the license_cloud_info.log File**
590+
## 6.1 Description of the license_cloud_info.log File
610591

611592
The license_cloud_info.log file records:
612593

@@ -620,7 +601,7 @@ The license_cloud_info.log file records:
620601

621602
- **Any error messages encountered.**
622603

623-
**6.2 How to Interpret Records in the Log**
604+
## 6.2 How to Interpret Records in the Log
624605

625606
Each entry starts with a timestamp and includes the operation
626607
performed.\
@@ -690,7 +671,7 @@ update the uploaded code.
690671

691672
------------------------------------------------------------------------
692673

693-
**Appendix A: Installation of Required Packages**
674+
# Appendix A: Installation of Required Packages
694675

695676
The secure_python_code_manager.py script requires the following Python
696677
packages:
@@ -717,7 +698,7 @@ installing the packages.
717698

718699
------------------------------------------------------------------------
719700

720-
**Appendix B: Contact Information**
701+
# Appendix B: Contact Information
721702

722703
If you experience issues or have questions not covered in this
723704
documentation, please contact the Alpha Beta Network Research Team.

0 commit comments

Comments
 (0)