Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Sweep: Refactor the Readme fille (✓ Sandbox Passed) #6

Open
wants to merge 53 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
Show all changes
53 commits
Select commit Hold shift + click to select a range
f7ecd05
feat: Updated README.md
onuratakan Mar 9, 2024
a39474c
Merge main into sweep/refactor_the_readme_fille
onuratakan Mar 9, 2024
1ce51e0
Merge main into sweep/refactor_the_readme_fille
onuratakan Mar 11, 2024
b7dc340
Merge main into sweep/refactor_the_readme_fille
onuratakan Mar 11, 2024
aaaae56
Merge main into sweep/refactor_the_readme_fille
onuratakan Mar 13, 2024
e3b4c99
Merge main into sweep/refactor_the_readme_fille
onuratakan Mar 15, 2024
c6b81e3
Merge main into sweep/refactor_the_readme_fille
onuratakan Mar 15, 2024
ad94e1f
Merge main into sweep/refactor_the_readme_fille
onuratakan Mar 15, 2024
8acab50
Merge main into sweep/refactor_the_readme_fille
onuratakan Mar 15, 2024
12f1f56
Merge main into sweep/refactor_the_readme_fille
onuratakan Mar 17, 2024
6873c85
Merge main into sweep/refactor_the_readme_fille
onuratakan Mar 17, 2024
75a87d1
Merge main into sweep/refactor_the_readme_fille
onuratakan Mar 17, 2024
7653c3e
Merge main into sweep/refactor_the_readme_fille
onuratakan Mar 17, 2024
cc36f0a
Merge main into sweep/refactor_the_readme_fille
onuratakan Mar 17, 2024
8f0c0a6
Merge main into sweep/refactor_the_readme_fille
onuratakan Mar 17, 2024
6ecfbc1
Merge main into sweep/refactor_the_readme_fille
onuratakan Mar 18, 2024
f9bbd04
Merge main into sweep/refactor_the_readme_fille
onuratakan Mar 18, 2024
f588fc0
Merge main into sweep/refactor_the_readme_fille
onuratakan Mar 18, 2024
797b1d5
Merge main into sweep/refactor_the_readme_fille
onuratakan Mar 18, 2024
85c7d0d
Merge main into sweep/refactor_the_readme_fille
onuratakan Mar 18, 2024
f480b73
Merge main into sweep/refactor_the_readme_fille
onuratakan Mar 19, 2024
91c72a9
Merge main into sweep/refactor_the_readme_fille
onuratakan Mar 19, 2024
f0888d1
Merge main into sweep/refactor_the_readme_fille
onuratakan Mar 19, 2024
27a5cb5
Merge main into sweep/refactor_the_readme_fille
onuratakan Mar 19, 2024
ffbfc54
Merge main into sweep/refactor_the_readme_fille
onuratakan Mar 19, 2024
c16470e
Merge main into sweep/refactor_the_readme_fille
onuratakan Mar 19, 2024
7b37929
Merge main into sweep/refactor_the_readme_fille
onuratakan Mar 19, 2024
369de49
Merge main into sweep/refactor_the_readme_fille
onuratakan Mar 19, 2024
a728b98
Merge main into sweep/refactor_the_readme_fille
onuratakan Mar 19, 2024
e26acc5
Merge main into sweep/refactor_the_readme_fille
onuratakan Mar 19, 2024
55108bb
Merge main into sweep/refactor_the_readme_fille
onuratakan Mar 19, 2024
4091276
Merge main into sweep/refactor_the_readme_fille
onuratakan Mar 19, 2024
67f6e53
Merge main into sweep/refactor_the_readme_fille
onuratakan Mar 19, 2024
78c4335
Merge main into sweep/refactor_the_readme_fille
onuratakan Mar 19, 2024
d8773e8
Merge main into sweep/refactor_the_readme_fille
onuratakan Mar 19, 2024
b3190fa
Merge main into sweep/refactor_the_readme_fille
onuratakan Mar 19, 2024
3c62923
Merge main into sweep/refactor_the_readme_fille
onuratakan Mar 19, 2024
7661083
Merge main into sweep/refactor_the_readme_fille
onuratakan Mar 20, 2024
fbfcb3e
Merge main into sweep/refactor_the_readme_fille
onuratakan Mar 20, 2024
3dff407
Merge main into sweep/refactor_the_readme_fille
onuratakan Mar 20, 2024
5c9dba7
Merge main into sweep/refactor_the_readme_fille
onuratakan Mar 20, 2024
a01a478
Merge main into sweep/refactor_the_readme_fille
onuratakan Mar 20, 2024
abace0d
Merge main into sweep/refactor_the_readme_fille
onuratakan Mar 20, 2024
883aeb9
Merge main into sweep/refactor_the_readme_fille
onuratakan Mar 21, 2024
7456042
Merge main into sweep/refactor_the_readme_fille
onuratakan Mar 21, 2024
bb12b3a
Merge main into sweep/refactor_the_readme_fille
onuratakan Mar 21, 2024
718e4d2
Merge main into sweep/refactor_the_readme_fille
onuratakan Mar 21, 2024
82fa77d
Merge main into sweep/refactor_the_readme_fille
onuratakan Mar 21, 2024
50c4f72
Merge main into sweep/refactor_the_readme_fille
onuratakan Mar 24, 2024
c83fecf
Merge main into sweep/refactor_the_readme_fille
onuratakan Mar 24, 2024
9ca0ad3
Merge main into sweep/refactor_the_readme_fille
onuratakan Mar 24, 2024
489ac09
Merge main into sweep/refactor_the_readme_fille
onuratakan Mar 27, 2024
b839990
Merge main into sweep/refactor_the_readme_fille
onuratakan Mar 27, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 30 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,36 @@ Once the container is up and running, you can install the Upsonic Python Client

## Usage

Here's an updated quickstart guide to get you up and running with your container:
Upsonic streamlines the development and deployment of utility libraries. Here's how to get started:

### Basic Usage

1. Initialize Upsonic with your server's address:
```python
from upsonic import Upsonic_On_Prem
upsonic = Upsonic_On_Prem('https://your-server-address:5000', 'ACK_****************')
```

2. Define a function you wish to serialize and share:
```python
def sum(a, b):
return a + b
```

3. Serialize the function for Upsonic:
```python
upsonic.dump("math.basics.sum", sum)
```

4. Import and use the serialized function in another project:
```python
math = upsonic.load_module("math")
math.basics.sum(5, 2)
```

### Advanced Usage

For complex scenarios and advanced usage, refer to our [detailed documentation](https://docs.upsonic.co/home).

```python
from upsonic import Upsonic_On_Prem
Expand Down
Loading