Skip to content

Commit b0c1a24

Browse files
committed
Update documentation
1 parent 9ab913a commit b0c1a24

1 file changed

Lines changed: 2 additions & 4 deletions

File tree

README.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
```bash
1313
git remote add template https://github.com/StatelessStudio/typescript-template-library/ && git pull template master --allow-unrelated-histories && git remote remove template
1414
```
15-
3. Replace "typescript-template-library" with the name of your app project-wide (**No Spaces or special characters except dash!**)
15+
3. Replace "typescript-template-library" with the name of your library project-wide (**No Spaces or special characters except dash!**)
1616
4. `npm i`
1717
5. Update the documentation, changelog, etc
1818

@@ -28,11 +28,9 @@ Run a dev test with `npm start`.
2828

2929
Here's a rundown of where to put your code, see each file for more information:
3030

31+
- **script/example.ts**: Create an example application that uses your library
3132
- **src/environment.ts**: Setup environment variables here
3233
- **src/index.ts**: You don't typically need to edit this file, it just initializes and starts your app.
33-
- **src/log.ts**: This is your project's log, import this file to use the log. You can also extend/replace the log.
34-
- **src/main.ts**: This is the main entrypoint for your application, after services have been registered.
35-
- **src/register.ts**: This file initializes services such as database, SMTP, etc. that are used across different entrypoints of your application.
3634

3735
## Running Tests
3836

0 commit comments

Comments
 (0)