Commit Graph

245 Commits

Author SHA1 Message Date
Justin Ma
5fe0ca418d
Remove npm install instruction (#9022) 2023-04-27 18:44:51 +08:00
Justin Ma
07598c9620
Add npm installation instruction (#8982)
# Description

Add `npm` install instruction to README.md
2023-04-24 09:22:42 -05:00
Stefan Holderbach
b9808c8598
Reenable CI coverage (#8867)
# Description
Let's see if we don't run out of disk space as quickly again

This reverts commit 0e496f900d.
(#8677)



# User-Facing Changes
<!-- List of all changes that impact the user experience here. This
helps us keep track of breaking changes. -->

# Tests + Formatting

Same coverage setup as before
2023-04-13 15:27:02 +12:00
JT
50ca77437d
Add atuin to official support (#8757)
# Description

_(Thank you for improving Nushell. Please, check our [contributing
guide](../CONTRIBUTING.md) and talk to the core team before making major
changes.)_

_(Description of your pull request goes here. **Provide examples and/or
screenshots** if your changes affect the user experience.)_

# User-Facing Changes

_(List of all changes that impact the user experience here. This helps
us keep track of breaking changes.)_

# Tests + Formatting

Don't forget to add tests that cover your changes.

Make sure you've run and fixed any issues with these commands:

- `cargo fmt --all -- --check` to check standard code formatting (`cargo
fmt --all` applies these changes)
- `cargo clippy --workspace -- -D warnings -D clippy::unwrap_used -A
clippy::needless_collect` to check that you're using the standard code
style
- `cargo test --workspace` to check that all tests pass
- `cargo run -- crates/nu-utils/standard_library/tests.nu` to run the
tests for the standard library

> **Note**
> from `nushell` you can also use the `toolkit` as follows
> ```bash
> use toolkit.nu # or use an `env_change` hook to activate it
automatically
> toolkit check pr
> ```

# After Submitting

If your PR had any user-facing changes, update [the
documentation](https://github.com/nushell/nushell.github.io) after the
PR is merged, if necessary. This will help us keep the docs up to date.
2023-04-05 13:08:32 -05:00
JT
0e496f900d
Remove CI coverage until we can figure out why it's broken (#8677)
# Description

The coverage testing on CI has been broken for at least a week. It looks
like we might have to do some work, but for now, disabling it so we
don't give bad stability info to contributors.

# User-Facing Changes

_(List of all changes that impact the user experience here. This helps
us keep track of breaking changes.)_

# Tests + Formatting

Don't forget to add tests that cover your changes.

Make sure you've run and fixed any issues with these commands:

- `cargo fmt --all -- --check` to check standard code formatting (`cargo
fmt --all` applies these changes)
- `cargo clippy --workspace -- -D warnings -D clippy::unwrap_used -A
clippy::needless_collect` to check that you're using the standard code
style
- `cargo test --workspace` to check that all tests pass
- `cargo run -- crates/nu-utils/standard_library/tests.nu` to run the
tests for the standard library

> **Note**
> from `nushell` you can also use the `toolkit` as follows
> ```bash
> use toolkit.nu # or use an `env_change` hook to activate it
automatically
> toolkit check pr
> ```

# After Submitting

If your PR had any user-facing changes, update [the
documentation](https://github.com/nushell/nushell.github.io) after the
PR is merged, if necessary. This will help us keep the docs up to date.
2023-03-31 06:49:26 +13:00
Michael Angerman
bc54930bc6
one more try on readme (#8659)
# Description

Take 2...

_(Thank you for improving Nushell. Please, check our [contributing
guide](../CONTRIBUTING.md) and talk to the core team before making major
changes.)_

_(Description of your pull request goes here. **Provide examples and/or
screenshots** if your changes affect the user experience.)_

# User-Facing Changes

_(List of all changes that impact the user experience here. This helps
us keep track of breaking changes.)_

# Tests + Formatting

Don't forget to add tests that cover your changes.

Make sure you've run and fixed any issues with these commands:

- `cargo fmt --all -- --check` to check standard code formatting (`cargo
fmt --all` applies these changes)
- `cargo clippy --workspace -- -D warnings -D clippy::unwrap_used -A
clippy::needless_collect` to check that you're using the standard code
style
- `cargo test --workspace` to check that all tests pass

> **Note**
> from `nushell` you can also use the `toolkit` as follows
> ```bash
> use toolkit.nu # or use an `env_change` hook to activate it
automatically
> toolkit check pr
> ```

# After Submitting

If your PR had any user-facing changes, update [the
documentation](https://github.com/nushell/nushell.github.io) after the
PR is merged, if necessary. This will help us keep the docs up to date.
2023-03-28 22:19:33 -07:00
Michael Angerman
0d6e43097d
Add the showcase repo to Readme.md to give it more exposure to our developers (#8658)
# Description

The showcase repo has some cool material in it that I think is valuable
for our readers developers. Giving it a bit more exposure by putting it
our Readme will allow more folks to know this is yet another valuable
resource. I learned about this today from Darren and thought it would be
good to allow others the same opportunity to find it easier as well...

_(Thank you for improving Nushell. Please, check our [contributing
guide](../CONTRIBUTING.md) and talk to the core team before making major
changes.)_

_(Description of your pull request goes here. **Provide examples and/or
screenshots** if your changes affect the user experience.)_

# User-Facing Changes

_(List of all changes that impact the user experience here. This helps
us keep track of breaking changes.)_

# Tests + Formatting

Don't forget to add tests that cover your changes.

Make sure you've run and fixed any issues with these commands:

- `cargo fmt --all -- --check` to check standard code formatting (`cargo
fmt --all` applies these changes)
- `cargo clippy --workspace -- -D warnings -D clippy::unwrap_used -A
clippy::needless_collect` to check that you're using the standard code
style
- `cargo test --workspace` to check that all tests pass

> **Note**
> from `nushell` you can also use the `toolkit` as follows
> ```bash
> use toolkit.nu # or use an `env_change` hook to activate it
automatically
> toolkit check pr
> ```

# After Submitting

If your PR had any user-facing changes, update [the
documentation](https://github.com/nushell/nushell.github.io) after the
PR is merged, if necessary. This will help us keep the docs up to date.
2023-03-28 22:12:07 -07:00
Stefan Holderbach
0a1af85200
Fix codecov badge (#8279) 2023-03-02 06:34:12 +13:00
Stefan Holderbach
728e95c52b
Add links to the remaining README badges (#8191)
Quicklinks to metrics. When we are proud to display them as badges,
let's show of the underlying statistics as well. Also helpful to quickly
get to the actions.
2023-02-24 12:58:44 +01:00
Darren Schroeder
68ad854b0d
update link to command reference (#8111)
# Description

Broken link

# User-Facing Changes

_(List of all changes that impact the user experience here. This helps
us keep track of breaking changes.)_

# Tests + Formatting

Don't forget to add tests that cover your changes.

Make sure you've run and fixed any issues with these commands:

- `cargo fmt --all -- --check` to check standard code formatting (`cargo
fmt --all` applies these changes)
- `cargo clippy --workspace -- -D warnings -D clippy::unwrap_used -A
clippy::needless_collect` to check that you're using the standard code
style
- `cargo test --workspace` to check that all tests pass

# After Submitting

If your PR had any user-facing changes, update [the
documentation](https://github.com/nushell/nushell.github.io) after the
PR is merged, if necessary. This will help us keep the docs up to date.
2023-02-18 07:38:36 -06:00
JT
64b6c02a22
Add codecov badge 2023-02-12 08:39:37 +13:00
TornaxO7
c4818d79f3
adding link to list of nu-plugins (#7649)
Co-authored-by: Stefan Holderbach <sholderbach@users.noreply.github.com>
2023-01-03 13:50:21 +01:00
Jérémy Audiger
f3d2be7a56
doc: correct some really tiny typos. (#7635) 2022-12-30 13:18:28 +01:00
JT
fdd92b2dda
Update README.md 2022-12-16 18:50:37 +13:00
JT
cfb0f3961b
Simple README updates (#7279)
# Description

_(Thank you for improving Nushell. Please, check our [contributing
guide](../CONTRIBUTING.md) and talk to the core team before making major
changes.)_

_(Description of your pull request goes here. **Provide examples and/or
screenshots** if your changes affect the user experience.)_

# User-Facing Changes

_(List of all changes that impact the user experience here. This helps
us keep track of breaking changes.)_

# Tests + Formatting

Don't forget to add tests that cover your changes.

Make sure you've run and fixed any issues with these commands:

- `cargo fmt --all -- --check` to check standard code formatting (`cargo
fmt --all` applies these changes)
- `cargo clippy --workspace -- -D warnings -D clippy::unwrap_used -A
clippy::needless_collect` to check that you're using the standard code
style
- `cargo test --workspace` to check that all tests pass

# After Submitting

If your PR had any user-facing changes, update [the
documentation](https://github.com/nushell/nushell.github.io) after the
PR is merged, if necessary. This will help us keep the docs up to date.
2022-11-30 08:10:11 +13:00
JT
58d960d914
Update README re: typechecking (#7094) 2022-11-11 15:16:10 +13:00
Jakob Endler
378248341e
Update README.md (#6782)
Fixed a very small inconsistency.
2022-10-17 06:23:11 -05:00
Justin Ma
43a218240c
Add setup-nu link in README.md (#5763) 2022-06-13 17:40:38 +08:00
Darren Schroeder
837f0463eb
updated Dir to dir 2022-06-07 14:58:23 -05:00
Reilly Wood
56f6f683fc
Clean up README (#5718)
* Clean up README

* Update CONTRIBUTING.md

* Another pass over the README. Table of contents, more install info

* add a little extra features definition

* fix Winget instructions

* Change winget instructions to nushell (easier to remember)

Co-authored-by: Darren Schroeder <343840+fdncred@users.noreply.github.com>
2022-06-07 12:47:08 -07:00
Justin Ma
1bcb87c48d
Update rust version (#5432) 2022-05-04 13:56:31 +12:00
Darren Schroeder
f6b99b2d8f
update build status badge (#5321) 2022-04-24 16:28:54 -05:00
Darren Schroeder
3eb447030b
update contrib to max=500 (#5317) 2022-04-24 13:03:20 -05:00
Darren Schroeder
2a18206771
add virtualenv to integrations (#5280) 2022-04-21 06:50:32 -05:00
Darren Schroeder
6a1378c1bb
Update README.md 2022-04-15 05:27:42 -05:00
Darren Schroeder
56af7e8d5f
tweak badge (#5187)
added `?branch=main?event=push` to see if it makes any difference.
2022-04-14 06:48:17 -05:00
Stefan Holderbach
1f6e0255c0
Fix typo in link (#5168)
skip-checks:true
2022-04-12 22:13:40 +02:00
JT
b61af9a26a
Update README.md 2022-04-13 06:24:46 +12:00
JT
6e2f6c71fe
Update README.md 2022-04-13 06:15:34 +12:00
JT
f51d5789a3
Update README.md 2022-04-13 06:15:09 +12:00
JT
933cee27ae
Update README.md 2022-04-13 06:12:33 +12:00
Felix Rath
0c9dd6a29a
Update README.md for Rust 1.59 (#4995)
Since `Cargo.toml` now specifies `strip = ...`, and `strip` is only available in cargo >=1.59, specify that at least this version is required.
2022-03-28 07:28:04 +13:00
Justin Ma
ae7c0b1097
Fix broken link in readme, should close #4776 [ci skip] (#4778) 2022-03-08 06:30:11 -05:00
dgalbraith
eeef9f27eb
Add installation instructions using Chocolatey (#4714)
Add installation instructions for Nushell on Windows using the
Chocolatey package manager.
2022-03-03 15:26:06 -06:00
zkldi
c6a3066103
Document Visual C++ requirement on Windows. (#4641)
Should fix #4563.
2022-02-25 13:04:10 -05:00
JT
da42100374
Update README.md 2022-02-18 20:30:58 -05:00
JT
dfc478e074
Update README.md 2022-02-18 20:30:23 -05:00
JT
3576350b4b
Update README.md 2022-02-13 07:57:38 -05:00
JT
b16e72f0a5
Update README.md 2022-02-08 13:59:08 -05:00
JT
56ba57c74a
Update README.md 2022-02-08 13:57:40 -05:00
JT
cdc8e67d61
Remove unused repo parts (#4271)
* Remove unused repo parts

* Update README

* cargo fmt
2022-01-26 07:31:04 +11:00
Leo Dutra
493bc2b1c9
Update README (#4118)
`winget install nu` fails because there's other options for "nu" now.
Using the full `nushell` word solved it for me.

[Imgur](https://imgur.com/aqz2qNp)
2021-11-14 19:34:57 +13:00
JT
b3b3cf0689
Remove the docker instructions
Docker has been out of date for a long time, go ahead and remove.
2021-09-20 19:33:49 +12:00
Darren Schroeder
28db8022fe
Update README.md
added integrations and mentions in supported section
2021-08-05 07:35:22 -05:00
Darren Schroeder
55acdaaf8c
add officially supported by section (#3895) 2021-08-04 15:57:57 -05:00
mukund
2b80f40164
Remove outdated note in README.md. (#3751) 2021-07-09 06:04:02 +12:00
vlad doster
04c0e94349
(docs) update README.md (#3630)
- suggest grammar changes
- correct punctuation
- make code fences consistently use `shell` vs `bash` && `shell`
2021-06-16 14:55:10 -05:00
JT
18be6768c9
Update README.md 2021-06-16 18:24:21 +12:00
JT
fbe61a06f6
Update README.md 2021-06-16 18:23:27 +12:00
itsme-alan
6f0dd8e885
Update README.md (#3615) 2021-06-14 20:52:07 +12:00