Don’t go down the rabbit hole: Use room READMEs

| February 16, 2017

If Alice had had a README to reference down in Wonderland, she wouldn’t have had to figure out what “Eat me” and “Drink me” would lead to via trial and error. Same goes in HipChat. Ever entered a room and not known its purpose? Or not known if you’re meant to be there? Room READMEs solve this.

So what are Room READMEs, you ask? And what benefits do they provide in a HipChat room?

A README is a file containing information about other files in an archive, directory, or website. Think of it as a file containing all the information you need to know in order to use the other files (or website, or whatever) correctly—kind of like the list of policies in a library, or perhaps a how-to guide.

Our twist on READMEs gives you the perfect place to explain the room you’re in—what it’s for, what the rules are, contact information, relevant links, whatever you need to make sure its members can get the most out of it.

And accessing it is simple: just click on the button in your right sidebar. To create or edit the README, click the Edit button in the lower right corner. A rich text editor will pop up, allowing you to format it the way you want (it even supports emoticons!):

HipChat readmeThen click Save, and you’re done! From then on, just click on the Room README button in the right sidebar to access it.HipChat readme integration

Information at your fingertips—what’s better than that?