Skip to content

Commit

Permalink
Make the README more correct
Browse files Browse the repository at this point in the history
  • Loading branch information
CaspianA1 committed Jun 27, 2024
1 parent 710ab34 commit c8b505c
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# DBOS typescript-eslint plugin
typescript-eslint plugin for DBOS sdk
typescript-eslint plugin for DBOS SDK

The [DBOS SDK](https://github.com/dbos-inc/dbos-ts) (from [DBOS, Inc.](https://dbos.dev)) is a **Typescript framework built on the database** that helps you develop transactional backend applications.

This [eslint](https://eslint.org) plugin assists in the following aspects of coding:
This [typescript-eslint](https://typescript-eslint.io/) plugin assists in the following aspects of coding:
- Correct use of the DBOS SDK
- Conformance to TypeScript best practices
- Identification of code that may contain security vulnerabilities and unexpected nondeterminism
Expand All @@ -12,7 +12,7 @@ This [eslint](https://eslint.org) plugin assists in the following aspects of cod

The fastest way to get started with DBOS is by following the [quickstart](https://docs.dbos.dev/getting-started/quickstart), where you'll learn how to get a backend running in less than five minutes.

The tutorial and examples include setup of `eslint` with this plugin.
The tutorial and examples include setup of `typescript-eslint` with this plugin.

## Additional Documentation

Expand Down

0 comments on commit c8b505c

Please sign in to comment.