npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

com.rmc.rmc-readme

v1.2.2

Published

ReadMe library for Unity Development by Rivello Multimedia Consulting

Downloads

255

Readme

npm package License: MIT

RMC Readme

How to use

This is a custom library to display a custom ReadMe for the Unity Inspector Window.

If you also want to author a custom ReadMe, see the https://github.com/SamuelAsherRivello/rmc-readme-authoring.

Install

Via NPM

You can either use the Unity Package Manager Window (UPM) or directly edit the manifest file. The result will be the same.

UPM

To use the Package Manager Window, first add a Scoped Registry, then click on the interface menu ( Status Bar → (+) Icon → Add Package By Name ... ).

Manifest File

Or to edit the Packages/manifest.json directly with your favorite text editor, add a scoped registry then the following line(s) to dependencies block:

{
  "scopedRegistries": [
    {
      "name": "npmjs",
      "url": "https://registry.npmjs.org/",
      "scopes": [
        "com.rmc"
      ]
    }
  ],
  "dependencies": {
    "com.rmc.rmc-readme": "1.2.2"
  }
}

Package should now appear in package manager.

Via Git URL

You can either use the Unity Package Manager (UPM) Window or directly edit the manifest file. The result will be the same.

UPM

To use the Package Manager Window click on the interface menu ( Status Bar → (+) Icon → Add Package From Git Url ... ).

Manifest File

Or to edit the Packages/manifest.json directly with your favorite text editor, add following line(s) to the dependencies block:

{
  "dependencies": {
      "com.rmc.rmc-readme": "https://github.com/SamuelAsherRivello/rmc-readme.git"
  }
}

Tests

The package can optionally be set as testable. In practice this means that tests in the package will be visible in the Unity Test Runner.

Open Packages/manifest.json with your favorite text editor. Add following line after the dependencies block:

{
  "dependencies": {
  },
  "testables": [ "com.rmc.rmc-readme" ]
}

Samples

Some packages include optional samples with clear use cases. To import and run the samples:

  1. Open Unity
  2. Complete the package installation (See above)
  3. Open the Package Manager Window
  4. Select this package
  5. Select samples
  6. Import

Configuration

Created By

  • Samuel Asher Rivello
  • Over 23 years XP with game development (2023)
  • Over 10 years XP with Unity (2023)

Contact

  • Twitter - @srivello
  • Resume & Portfolio - SamuelAsherRivello.com
  • Source Code on Git - Github.com/SamuelAsherRivello
  • LinkedIn - Linkedin.com/in/SamuelAsherRivello <--- Say Hello! :)

License

Provided as-is under MIT License | Copyright © 2023 Rivello Multimedia Consulting, LLC