Add README.md
This commit is contained in:
24
README.md
Normal file
24
README.md
Normal file
@@ -0,0 +1,24 @@
|
||||
# Demo Project
|
||||
|
||||
This is a simple demo project that includes a function to add two numbers.
|
||||
|
||||
## Usage
|
||||
|
||||
```python
|
||||
from demo import add
|
||||
|
||||
result = add(1, 2) # Returns 3
|
||||
print(result)
|
||||
```
|
||||
|
||||
## Function Description
|
||||
|
||||
- `add(a, b)`: Takes two numbers as arguments and returns their sum.
|
||||
|
||||
## Project Structure
|
||||
|
||||
```
|
||||
.
|
||||
├── demo.py # Contains the add function
|
||||
└── README.md # This file
|
||||
```
|
||||
Reference in New Issue
Block a user