Skip to content

Commit 9c41013

Browse files
committed
docs: fix grammar and wordring in README
1 parent 9bf06a9 commit 9c41013

File tree

1 file changed

+17
-17
lines changed

1 file changed

+17
-17
lines changed

README.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -8,21 +8,21 @@
88
[![All Contributors](https://img.shields.io/badge/all_contributors-17-orange.svg?style=flat-square)](#contributors-)
99
<!-- ALL-CONTRIBUTORS-BADGE:END -->
1010

11-
⚡ Building applications with LLMs through composability ⚡
11+
⚡ Building applications with LLMs through composability ⚡
1212
C# implementation of LangChain. We try to be as close to the original as possible in terms of abstractions, but are open to new entities.
1313

14-
While the [SemanticKernel](https://github.com/microsoft/semantic-kernel/) is good and we will use it wherever possible, we believe that it has many limitations and based on Microsoft technologies.
15-
We proceed from the position of the maximum choice of available options and are open to using third-party libraries within individual implementations.
14+
While the [SemanticKernel](https://github.com/microsoft/semantic-kernel/) is useful and we will use it wherever possible, we believe that it has several limitations and is based on Microsoft technologies.
15+
We proceed from the position of the maximum choice of available options and are open to using third-party libraries within individual implementations.
1616

17-
I want to note:
17+
Maintainer notes:
1818
- I’m unlikely to be able to make serious progress alone, so my goal is to unite the efforts of C# developers to create a C# version of LangChain and control the quality of the final project
1919
- I try to accept any Pull Request within 24 hours (of course, it depends, but I will try)
2020
- I'm also looking for developers to join the core team. I will sponsor them whenever possible and also share any money received.
2121
- I also respond quite quickly on Discord for any questions related to the project
2222

2323
## Usage
24-
You can use our wiki to get started: https://tryagi.github.io/LangChain/
25-
If the wiki contains unupdated code, you can always take a look at [the tests for this](src/Meta/test/WikiTests.cs)
24+
You can use our wiki to get started: https://tryagi.github.io/LangChain/
25+
If the wiki contains outdated code, you can always take a look at [the tests for this](src/Meta/test/WikiTests.cs)
2626
Also see [examples](./examples) for example usage or [tests](./src/tests/LangChain.IntegrationTests/ReadmeTests.cs).
2727
```csharp
2828
// Price to run from zero(create embeddings and request to LLM): 0,015$
@@ -36,7 +36,7 @@ var provider = new OpenAiProvider(
3636
var llm = new OpenAiLatestFastChatModel(provider);
3737
var embeddingModel = new TextEmbeddingV3SmallModel(provider);
3838

39-
// Create vector database from Harry Potter book pdf
39+
// Create vector database from Harry Potter book PDF
4040
using var vectorDatabase = new SqLiteVectorDatabase(dataSource: "vectors.db");
4141
var vectorCollection = await vectorDatabase.AddDocumentsFromAsync<PdfPigPdfLoader>(
4242
embeddingModel, // Used to convert text to embeddings
@@ -83,7 +83,7 @@ var chain =
8383
var chainAnswer = await chain.RunAsync("text"); // get chain result
8484
8585
Console.WriteLine("Chain Answer:"+ chainAnswer); // print the result
86-
86+
8787
Console.WriteLine($"LLM usage: {llm.Usage}"); // Print usage and price
8888
Console.WriteLine($"Embedding model usage: {embeddingModel.Usage}"); // Print usage and price
8989
```
@@ -97,16 +97,16 @@ Console.WriteLine($"Embedding model usage: {embeddingModel.Usage}"); // Print
9797

9898
## Support
9999

100-
Priority place for bugs: https://github.com/tryAGI/LangChain/issues
101-
Priority place for ideas and general questions: https://github.com/tryAGI/LangChain/discussions
102-
Discord: https://discord.gg/Ca2xhfBf3v
100+
Priority place for bugs: https://github.com/tryAGI/LangChain/issues
101+
Priority place for ideas and general questions: https://github.com/tryAGI/LangChain/discussions
102+
Discord: https://discord.gg/Ca2xhfBf3v
103103

104104
## Legal information and credits
105-
It's licensed under [the MIT license](LICENSE). We do not plan to change the license in any foreseeable future for this project,
106-
but projects based on this within the organization may have different licenses.
107-
Some documentation is based on documentation from [dotnet/docs](https://github.com/dotnet/docs/) repository
108-
under [CC BY 4.0 license](https://github.com/dotnet/docs/blob/main/LICENSE),
109-
where code examples are changed to code examples for using this project.
105+
It's licensed under [the MIT license](LICENSE). We do not plan to change the license in any foreseeable future for this project,
106+
but projects based on this within the organization may have different licenses.
107+
Some documentation is based on documentation from [dotnet/docs](https://github.com/dotnet/docs/) repository
108+
under [CC BY 4.0 license](https://github.com/dotnet/docs/blob/main/LICENSE),
109+
where code examples are changed to code examples for using this project.
110110

111111
## Acknowledgments
112112

@@ -116,4 +116,4 @@ This project is supported by JetBrains through the [Open Source Support Program]
116116

117117
![CodeRabbit logo](https://opengraph.githubassets.com/1c51002d7d0bbe0c4fd72ff8f2e58192702f73a7037102f77e4dbb98ac00ea8f/marketplace/coderabbitai)
118118

119-
This project is supported by CodeRabbit through the [Open Source Support Program](https://github.com/marketplace/coderabbitai).
119+
This project is supported by CodeRabbit through the [Open Source Support Program](https://github.com/marketplace/coderabbitai).

0 commit comments

Comments
 (0)