Dominic commited on
Commit
7bc05c2
·
unverified ·
2 Parent(s): 70c94c0 cdd1777

Merge pull request #36 from denizcandarcan/documentation-improvements

Browse files
Files changed (1) hide show
  1. README.md +10 -12
README.md CHANGED
@@ -47,7 +47,7 @@ async def main():
47
 
48
  # terminate the session
49
  await session.astop()
50
-
51
 
52
  if __name__ == "__main__":
53
  import asyncio
@@ -73,7 +73,7 @@ async def main():
73
  files = [
74
  File.from_path("examples/assets/iris.csv"),
75
  ]
76
-
77
  # generate the response
78
  response = await session.generate_response(
79
  user_request, files=files
@@ -96,20 +96,19 @@ Iris Dataset Analysis Output
96
 
97
  ## Production
98
 
99
- In case you want to deploy to production you can use the CodeBox API for easy scaling.
100
 
101
- Please contact me if you interested in this, because it's still in early development.
102
 
103
  ## Contributing
104
 
105
- There are some TODOs left in the code
106
- so if you want to contribute feel free to do so.
107
  You can also suggest new features. Code refactoring is also welcome.
108
  Just open an issue or pull request and I will review it.
109
 
110
- Also please submit any bugs you find as an issue
111
- with a minimal code example or screenshot.
112
- This helps me a lot to improve the code.
113
 
114
  Thanks!
115
 
@@ -124,8 +123,8 @@ But I prefer to use [Twitter](https://twitter.com/shroominic) or [Discord](https
124
 
125
  ## Support this project
126
 
127
- If you want to help this project with a donation you can [click here](https://ko-fi.com/shroominic).
128
- Thanks this helps alot! ❤️
129
 
130
  ## Star History
131
 
@@ -136,4 +135,3 @@ Thanks this helps alot! ❤️
136
  <img alt="Star History Chart" src="https://api.star-history.com/svg?repos=shroominic/codeinterpreter-api&type=Date" />
137
  </picture>
138
  </a>
139
-
 
47
 
48
  # terminate the session
49
  await session.astop()
50
+
51
 
52
  if __name__ == "__main__":
53
  import asyncio
 
73
  files = [
74
  File.from_path("examples/assets/iris.csv"),
75
  ]
76
+
77
  # generate the response
78
  response = await session.generate_response(
79
  user_request, files=files
 
96
 
97
  ## Production
98
 
99
+ In case you want to deploy to production, you can utilize the CodeBox API for seamless scalability.
100
 
101
+ Please contact me if you are interested in this, as it is still in the early stages of development.
102
 
103
  ## Contributing
104
 
105
+ There are some remaining TODOs in the code.
106
+ So, if you want to contribute, feel free to do so.
107
  You can also suggest new features. Code refactoring is also welcome.
108
  Just open an issue or pull request and I will review it.
109
 
110
+ Please also submit any bugs you find as an issue with a minimal code example or screenshot.
111
+ This helps me a lot in improving the code.
 
112
 
113
  Thanks!
114
 
 
123
 
124
  ## Support this project
125
 
126
+ If you would like to help this project with a donation, you can [click here](https://ko-fi.com/shroominic).
127
+ Thanks, this helps a lot! ❤️
128
 
129
  ## Star History
130
 
 
135
  <img alt="Star History Chart" src="https://api.star-history.com/svg?repos=shroominic/codeinterpreter-api&type=Date" />
136
  </picture>
137
  </a>