Skip to content

Commit 50d4e45

Browse files
authored
Update README.md
1 parent 42190ac commit 50d4e45

File tree

1 file changed

+15
-16
lines changed

1 file changed

+15
-16
lines changed

README.md

Lines changed: 15 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,23 @@
1-
# TypeScript Server Instance Project
21

3-
A robust project for managing and interacting with a TypeScript Server (TSServer). It includes an extensive array of functionalities such as file manipulation, code analysis, formatting, refactoring, and more, making it an ideal starting point for any TypeScript project requiring direct interaction with TSServer.
2+
# TypeScript Server (TSserver) Documentation Project
43

5-
## Code Guardian
6-
[![TSServer Instance build verification](https://github.com/aicore/template-nodejs/actions/workflows/build_verify.yml/badge.svg)](https://github.com/aicore/template-nodejs/actions/workflows/build_verify.yml)
4+
TSserver is a powerful tool that enhances TypeScript coding and project management. However, we recognize that the lack of human-readable documentation can be a barrier to effectively utilizing its full potential. To address this challenge, our project focuses on generating simple, accessible JSDoc documentation. Our goal is to make TSserver more user-friendly, allowing anyone to leverage its capabilities without the need to decipher complex TypeScript code syntaxes.
75

8-
# Commands available
6+
## Project Objective
97

10-
## Initialization
11-
To initialize the TypeScript Server:
12-
```shell
13-
> npm install // do this only once.
14-
> node -e 'require("./path-to-createTSServerInstance").init()'
15-
# Usage and Examples
8+
Our main objective is to transform the complex and cryptic syntaxes of TSserver into easy-to-understand documentation. We aim to provide clear, concise, and practical guides that cater to both beginners and experienced TypeScript developers.
169

17-
This TypeScript Server (TSServer) Instance project provides a wide range of functionalities to interact with TypeScript Server. Below are examples of how you can use these functionalities.
10+
## Getting Started
1811

19-
## Initialization
12+
To get started with TSserver using our JSDoc documentation:
2013

21-
Before you start, make sure to initialize the TypeScript Server:
14+
- Open the `utils/server.js` file in your project.
15+
- View the JSDoc comments above each function to understand their usage and capabilities.
2216

23-
```javascript
24-
const tsServer = require('./path-to-createTSServerInstance').init();
17+
## Contributing
18+
19+
We welcome contributions to improve and expand the documentation. If you have insights, examples, or enhancements, please feel free to contribute. Check out our [Contributing Guide](CONTRIBUTING.md) for guidelines on how to make submissions.
20+
21+
## License
22+
23+
This documentation project is open-source and available under the [AGPL License](LICENSE).

0 commit comments

Comments
 (0)