Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
pensivebrian authored Aug 23, 2022
1 parent 0f97c56 commit b874d0a
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
# mssql-cli
[**mssql-cli**](https://github.com/dbcli/mssql-cli) is an interactive command line query tool for SQL Server. This open source tool works cross-platform and proud to be a part of the [dbcli](https://github.com/dbcli) community.

![mssql-cli Autocomplete](https://github.com/dbcli/mssql-cli/raw/master/screenshots/mssql-cli-autocomplete.gif)
![mssql-cli Autocomplete](https://github.com/dbcli/mssql-cli/raw/main/screenshots/mssql-cli-autocomplete.gif)

mssql-cli supports a rich interactive command line experience, with features such as:
- **Auto-completion**: fewer keystrokes needed to complete complicated queries.
Expand All @@ -15,23 +15,23 @@ mssql-cli supports a rich interactive command line experience, with features suc
- **Non-interactive support**: execute a query without jumping into the interactive experience.

## Quick Start
Read the section below to quickly get started with mssql-cli. Consult the [usage guide](https://github.com/dbcli/mssql-cli/tree/master/doc/usage_guide.md) for a deeper dive into mssql-cli features.
Read the section below to quickly get started with mssql-cli. Consult the [usage guide](https://github.com/dbcli/mssql-cli/tree/main/doc/usage_guide.md) for a deeper dive into mssql-cli features.

### Install mssql-cli
Platform-specific installation instructions are below:
| [Windows](https://github.com/dbcli/mssql-cli/blob/master/doc/installation/windows.md#windows-installation) (preview) | [macOS](https://github.com/dbcli/mssql-cli/blob/master/doc/installation/macos.md#macos-installation) | [Linux](https://github.com/dbcli/mssql-cli/blob/master/doc/installation/linux.md) |
| [Windows](https://github.com/dbcli/mssql-cli/blob/main/doc/installation/windows.md#windows-installation) (preview) | [macOS](https://github.com/dbcli/mssql-cli/blob/main/doc/installation/macos.md#macos-installation) | [Linux](https://github.com/dbcli/mssql-cli/blob/main/doc/installation/linux.md) |
| - | - | - |

Visit the [installation reference guide](https://github.com/dbcli/mssql-cli/tree/master/doc/installation) to view all supported releases and downloads.
Visit the [installation reference guide](https://github.com/dbcli/mssql-cli/tree/main/doc/installation) to view all supported releases and downloads.

#### Install with Linux Package Manager
Follow the [Linux installation instructions]('https://github.com/dbcli/mssql-cli/blob/master/doc/installation/linux.md') to install mssql-cli using `apt-get`, `yum`, and other Linux package managers.
Follow the [Linux installation instructions]('https://github.com/dbcli/mssql-cli/blob/main/doc/installation/linux.md') to install mssql-cli using `apt-get`, `yum`, and other Linux package managers.

#### Install with pip
```sh
python -m pip install mssql-cli
```
Please refer to the [pip installation docs](https://github.com/dbcli/mssql-cli/blob/master/doc/installation/pip.md) for more platform-specific information.
Please refer to the [pip installation docs](https://github.com/dbcli/mssql-cli/blob/main/doc/installation/pip.md) for more platform-specific information.

### Connect to Server
Complete the command below to connect to your server:
Expand All @@ -49,13 +49,13 @@ mssql-cli --help
```

### Usage Docs
Please refer to the [usage guide](https://github.com/dbcli/mssql-cli/tree/master/doc/usage_guide.md) for details on options and example usage. If you are having any issues using mssql-cli, please see the [troubleshooting guide](https://github.com/dbcli/mssql-cli/blob/master/doc/troubleshooting_guide.md).
Please refer to the [usage guide](https://github.com/dbcli/mssql-cli/tree/main/doc/usage_guide.md) for details on options and example usage. If you are having any issues using mssql-cli, please see the [troubleshooting guide](https://github.com/dbcli/mssql-cli/blob/main/doc/troubleshooting_guide.md).

## Telemetry
The mssql-cli tool includes a telemetry feature. Please refer to the [telemetry guide](https://github.com/dbcli/mssql-cli/tree/master/doc/telemetry_guide.md) for more information.
The mssql-cli tool includes a telemetry feature. Please refer to the [telemetry guide](https://github.com/dbcli/mssql-cli/tree/main/doc/telemetry_guide.md) for more information.

## Contributing
If you would like to contribute to the project, please refer to the [development guide](https://github.com/dbcli/mssql-cli/tree/master/doc/development_guide.md).
If you would like to contribute to the project, please refer to the [development guide](https://github.com/dbcli/mssql-cli/tree/main/doc/development_guide.md).

## Contact Us
If you encounter any bugs or would like to leave a feature request, please file an issue in the
Expand All @@ -66,4 +66,4 @@ This project has adopted the [Microsoft Open Source Code of Conduct](https://ope
[email protected] with any additional questions or comments.

## License
mssql-cli is licensed under the [BSD-3 license](https://github.com/dbcli/mssql-cli/blob/master/LICENSE.txt).
mssql-cli is licensed under the [BSD-3 license](https://github.com/dbcli/mssql-cli/blob/main/LICENSE.txt).

0 comments on commit b874d0a

Please sign in to comment.