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

Convert the old rST docs into the new md ones. #287

Merged
merged 1 commit into from
Feb 20, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGES/128.misc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Converted the old docs to the new Markdown style.
37 changes: 35 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,38 @@
# pulp-npm

A Pulp plugin to support hosting your own npm.
<!--toc:start-->
- [pulp-npm](#pulp-npm)
- [About Pulp](#about-pulp)
- [About pulp_npm](#about-pulp_npm)
- [License](#license)
<!--toc:end-->

For more information, please see the [documentation](docs/index.rst) or the [Pulp project page](https://pulpproject.org/).
A Pulp plugin to support npm packages.

For more information, please see the [documentation](docs/index.md) or the [Pulp project page](https://pulpproject.org/).

## About Pulp
Pulp is a platform for managing repositories of content, such as software
packages, and pushing that content out to large numbers of consumers.

Using Pulp you can:
- Locally mirror all or part of a repository
- Host your own content in a new repository
- Manage content from multiple sources in one place
- Promote content through different repos in an organized way

## About pulp_npm
The plugin pulp_npm currently supports mirroring one specific version of a package and make it available.
Since the plugin is API compatible with the NPM Registry, you can use the `npm` CLI to download packages from Pulp.
For ex:
```
npm install --registry http://localhost:5001/pulp/content/{domain}/npm/ react
```

We are working to support more ways of mirroring the NPM Registry and allow uploads of npm content to pulp_npm.

## License
- License: GPLv2+
- Documentation: https://pulpproject.org/
- Source: https://github.com/pulp/pulp_npm/
- Bugs: https://github.com/pulp/pulp_npm/issues
199 changes: 0 additions & 199 deletions docs/Makefile

This file was deleted.

24 changes: 0 additions & 24 deletions docs/_templates/restapi.html

This file was deleted.

4 changes: 0 additions & 4 deletions docs/changes.rst

This file was deleted.

Loading