Skip to content

Commit

Permalink
docs(README): update
Browse files Browse the repository at this point in the history
  • Loading branch information
irishcarbomb777 committed Apr 14, 2024
1 parent ed61bbd commit 98e9061
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 7 deletions.
9 changes: 3 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,22 +3,19 @@
<img src="readme.assets/github.banner.png">
</P>

## This is our graph library. It helps you build graphs.
## This is a wrapper around Neo4j and OpenAI enabling streamlined handling of application data for AI use cases.

### Why?
Graphs are awesome. So are LLM's. This libraries goal is to help you merge these things so you can do awesome stuff like matching. Examples of this are matching Candidates to Open Jobs, Grant Opportunities to Eligible Small Businesses, and many more things.
Graph data models are awesome. So are LLM's. This libraries goal is to help you merge these things so you can do awesome stuff like matching. Examples of this are matching Candidates to Open Jobs, Grant Opportunities to Eligible Small Businesses, and many more things.

### **NOTE** Strict null checks must be on in tsconfig.json

### Why does this library exist?
Functional programming is awesome. TypeScript is awesomer. TypeScript and functional programming together allows you build really big things and not get lost. The goal of this library is to provide you with some sane defaults and reasonable programming interfaces that will enable you to build awesomely complex things from simple building blocks. The major goal is to keep this library as simple as possible. Graphs at their core are simple structures. They're flexible, useful, and can stand on their own without piles of overcomplication. It is my goal for this library to maintain those same properties. If it doesn't yell at me.
TypeScript and functional programming together allows you build really big things and not get lost. The goal of this library is to provide you with some sane defaults and reasonable programming interfaces that will enable you to build complex things from simple building blocks. The major goal is to keep this library as simple as possible.

### Inspired By
Zustand, Liveblocks, React, Neo4j, Cypher

### Shutup and show me some code.
Word.

### Installation
```bash
npm install @thinairthings/air-graph
Expand Down
2 changes: 1 addition & 1 deletion src/testing.ts
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ const {


const newJobNode = await createNode('Company', {
'companyName': 'Blueprint',
'companyName': 'Blueprint2',
})
// console.log(newJobNode)
// const updatedNode = await updateNode('Job', newJobNode!.nodeId, (nodeState) => {
Expand Down

0 comments on commit 98e9061

Please sign in to comment.