Skip to content
This repository was archived by the owner on Dec 8, 2021. It is now read-only.

Commit 8c5dfc2

Browse files
pcgeek86Tiberriver256
authored andcommitted
Improve README formatting and link to HttpListener (#207)
1 parent ed93821 commit 8c5dfc2

File tree

1 file changed

+6
-8
lines changed

1 file changed

+6
-8
lines changed

README.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -26,11 +26,11 @@ Start-Polaris
2626

2727
There have been a great list of [other](https://github.com/StartAutomating/Pipeworks) [micro](https://github.com/toenuff/flancy) [web](https://github.com/Jaykul/NancyPS/) [frameworks](https://github.com/toenuff/PshOdata) [written](https://github.com/straightdave/presley) [over](https://github.com/cofonseca/WebListener) [the](https://github.com/DataBooster/PS-WebApi) [years](https://github.com/ChristopherGLewis/PowerShellWebServers) (Thanks @jaykul for the list!).
2828

29-
Polaris' differentiation is that it is cross-platform and uses the .NET HttpListener class.
29+
Polaris' differentiation is that it is cross-platform and uses the .NET [HttpListener](https://docs.microsoft.com/en-us/dotnet/api/system.net.httplistener?view=netcore-3.1) class.
3030

3131
## Getting Started
3232

33-
### Prereqs
33+
### Prerequisites
3434

3535
- [PowerShell](https://github.com/powershell/powershell)
3636

@@ -39,7 +39,7 @@ Polaris' differentiation is that it is cross-platform and uses the .NET HttpList
3939
#### From the [PowerShell Gallery](https://powershellgallery.com)
4040

4141
```powershell
42-
PS > Install-Module Polaris
42+
PS > Install-Module -Name Polaris -Scope CurrentUser -Force
4343
```
4444

4545
You can now try out the [example above](#example) or checkout [the site](https://PowerShell.github.io/Polaris) for more usage information!
@@ -60,18 +60,16 @@ Check out the [docs folder](https://github.com/PowerShell/Polaris/tree/master/do
6060

6161
## Troubleshooting / Questions
6262

63-
**Twitter:** #PSPolaris
64-
**Slack:** See us in the #Polaris channel of the [PowerShell Slack](http://slack.poshcode.org/)
65-
**GitHub Issues:** Submit a bug / new feature idea / or just a question as a new GitHub issue
63+
- **Twitter:** #PSPolaris
64+
- **Slack:** See us in the #Polaris channel of the [PowerShell Slack](http://slack.poshcode.org/)
65+
- **GitHub Issues:** Submit a bug / new feature idea / or just a question as a new GitHub issue
6666

6767
## Roadmap
6868

6969
We have a few paths we are interested in taking. We hope the community helps direct us.
7070

7171
- Expanding on the current implementation using HttpListener to deliver features you'd expect from projects ASP.NET or Expressjs (route parameters, query parameters, middleware, auth etc)
72-
7372
- Investigating the use of [Kestrel](https://github.com/aspnet/KestrelHttpServer)/[ASP.NET Routing](https://github.com/aspnet/routing) instead of HttpListener
74-
7573
- Creating a routing domain-specific language (DSL) for isolating and running script blocks as routes. Drawing inspiration from [Pester](https://github.com/pester/Pester/).
7674

7775
## Feedback

0 commit comments

Comments
 (0)