Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add getting started example + SQL Server installation guide to README.md #1241

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

IanChokS
Copy link
Member

This adds a getting started example in the README page as well as a quick start up guide to install a SQL Server on docker.

@codecov
Copy link

codecov bot commented Mar 18, 2021

Codecov Report

Merging #1241 (ad507f4) into master (f6e1681) will decrease coverage by 0.02%.
The diff coverage is n/a.

❗ Current head ad507f4 differs from pull request most recent head 895865c. Consider uploading reports for the commit 895865c to get more accurate results
Impacted file tree graph

@@            Coverage Diff             @@
##           master    #1241      +/-   ##
==========================================
- Coverage   81.52%   81.50%   -0.03%     
==========================================
  Files          85       85              
  Lines        4536     4536              
  Branches      846      846              
==========================================
- Hits         3698     3697       -1     
- Misses        574      575       +1     
  Partials      264      264              
Impacted Files Coverage Δ
src/connection.ts 66.88% <0.00%> (-0.10%) ⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update f6e1681...895865c. Read the comment docs.

@IanChokS IanChokS changed the title refactor: add getting started page to README.md Add getting started example + SQL Server installation guide to README.md Mar 18, 2021
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
// Initialize the connection.
connection.connect();
```
### Setting up a SQL Server in Docker
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These steps seem to be windows specific, but use the linux container. Does this work out of the box on windows? What about using the windows container? Should we also have getting started steps for that?

@arthurschreiber
Copy link
Collaborator

Would you mind changing the commit type from refactor: to docs:?

docs: update README with set up examples
@IanChokS IanChokS force-pushed the ian/update-readme-with-getting-started branch from 895865c to 879b3e8 Compare June 25, 2021 00:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants